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 <rte_config.h>
42 #include <rte_common.h>
44 #include <rte_memory.h>
45 #include <rte_memzone.h>
46 #include <rte_tailq.h>
48 #include <rte_per_lcore.h>
49 #include <rte_launch.h>
50 #include <rte_atomic.h>
51 #include <rte_cycles.h>
52 #include <rte_prefetch.h>
53 #include <rte_lcore.h>
54 #include <rte_per_lcore.h>
55 #include <rte_branch_prediction.h>
56 #include <rte_interrupts.h>
58 #include <rte_random.h>
59 #include <rte_debug.h>
60 #include <rte_ether.h>
61 #include <rte_ethdev.h>
63 #include <rte_mempool.h>
66 #include <vlib/vlib.h>
68 #pragma weak rte_mem_virt2phy
69 #pragma weak rte_eal_has_hugepages
70 #pragma weak rte_socket_id
71 #pragma weak rte_pktmbuf_pool_create
74 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
75 vlib_buffer_t * b_first)
77 vlib_buffer_t *b = b_first;
78 uword l_first = b_first->current_length;
80 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
82 b = vlib_get_buffer (vm, b->next_buffer);
83 l += b->current_length;
85 b_first->total_length_not_including_first_buffer = l;
86 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
91 format_vlib_buffer (u8 * s, va_list * args)
93 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
94 uword indent = format_get_indent (s);
96 s = format (s, "current data %d, length %d, free-list %d",
97 b->current_data, b->current_length, b->free_list_index);
99 if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
100 s = format (s, ", totlen-nifb %d",
101 b->total_length_not_including_first_buffer);
103 if (b->flags & VLIB_BUFFER_IS_TRACED)
104 s = format (s, ", trace 0x%x", b->trace_index);
106 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
108 vlib_main_t *vm = vlib_get_main ();
109 u32 next_buffer = b->next_buffer;
110 b = vlib_get_buffer (vm, next_buffer);
112 s = format (s, "\n%Unext-buffer 0x%x, segment length %d",
113 format_white_space, indent, next_buffer, b->current_length);
121 format_vlib_buffer_and_data (u8 * s, va_list * args)
123 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
125 s = format (s, "%U, %U",
126 format_vlib_buffer, b,
127 format_hex_bytes, vlib_buffer_get_current (b), 64);
133 format_vlib_buffer_contents (u8 * s, va_list * va)
135 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
136 vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
140 vec_add (s, vlib_buffer_get_current (b), b->current_length);
141 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
143 b = vlib_get_buffer (vm, b->next_buffer);
149 vlib_main_t **vlib_mains;
151 /* Aligned copy routine. */
153 vlib_aligned_memcpy (void *_dst, void *_src, int n_bytes)
155 vlib_copy_unit_t *dst = _dst;
156 vlib_copy_unit_t *src = _src;
158 /* Arguments must be naturally aligned. */
159 ASSERT (pointer_to_uword (dst) % sizeof (dst[0]) == 0);
160 ASSERT (pointer_to_uword (src) % sizeof (src[0]) == 0);
161 ASSERT (n_bytes % sizeof (dst[0]) == 0);
163 if (4 * sizeof (dst[0]) == CLIB_CACHE_LINE_BYTES)
165 CLIB_PREFETCH (dst + 0, 4 * sizeof (dst[0]), WRITE);
166 CLIB_PREFETCH (src + 0, 4 * sizeof (src[0]), READ);
168 while (n_bytes >= 4 * sizeof (dst[0]))
172 n_bytes -= 4 * sizeof (dst[0]);
173 CLIB_PREFETCH (dst, 4 * sizeof (dst[0]), WRITE);
174 CLIB_PREFETCH (src, 4 * sizeof (src[0]), READ);
181 else if (8 * sizeof (dst[0]) == CLIB_CACHE_LINE_BYTES)
183 CLIB_PREFETCH (dst + 0, 8 * sizeof (dst[0]), WRITE);
184 CLIB_PREFETCH (src + 0, 8 * sizeof (src[0]), READ);
186 while (n_bytes >= 8 * sizeof (dst[0]))
190 n_bytes -= 8 * sizeof (dst[0]);
191 CLIB_PREFETCH (dst, 8 * sizeof (dst[0]), WRITE);
192 CLIB_PREFETCH (src, 8 * sizeof (src[0]), READ);
204 /* Cache line size unknown: fall back to slow version. */ ;
209 n_bytes -= 1 * sizeof (dst[0]);
213 #define BUFFERS_PER_COPY (sizeof (vlib_copy_unit_t) / sizeof (u32))
215 /* Make sure we have at least given number of unaligned buffers. */
217 fill_unaligned (vlib_main_t * vm,
218 vlib_buffer_free_list_t * free_list,
219 uword n_unaligned_buffers)
221 word la = vec_len (free_list->aligned_buffers);
222 word lu = vec_len (free_list->unaligned_buffers);
224 /* Aligned come in aligned copy-sized chunks. */
225 ASSERT (la % BUFFERS_PER_COPY == 0);
227 ASSERT (la >= n_unaligned_buffers);
229 while (lu < n_unaligned_buffers)
231 /* Copy 4 buffers from end of aligned vector to unaligned vector. */
232 vec_add (free_list->unaligned_buffers,
233 free_list->aligned_buffers + la - BUFFERS_PER_COPY,
235 la -= BUFFERS_PER_COPY;
236 lu += BUFFERS_PER_COPY;
238 _vec_len (free_list->aligned_buffers) = la;
241 /* After free aligned buffers may not contain even sized chunks. */
243 trim_aligned (vlib_buffer_free_list_t * f)
247 /* Add unaligned to aligned before trim. */
248 l = vec_len (f->unaligned_buffers);
251 vec_add_aligned (f->aligned_buffers, f->unaligned_buffers, l,
252 /* align */ sizeof (vlib_copy_unit_t));
254 _vec_len (f->unaligned_buffers) = 0;
257 /* Remove unaligned buffers from end of aligned vector and save for next trim. */
258 l = vec_len (f->aligned_buffers);
259 n_trim = l % BUFFERS_PER_COPY;
262 /* Trim aligned -> unaligned. */
263 vec_add (f->unaligned_buffers, f->aligned_buffers + l - n_trim, n_trim);
265 /* Remove from aligned. */
266 _vec_len (f->aligned_buffers) = l - n_trim;
271 merge_free_lists (vlib_buffer_free_list_t * dst,
272 vlib_buffer_free_list_t * src)
280 l = vec_len (src->aligned_buffers);
283 vec_add2_aligned (dst->aligned_buffers, d, l,
284 /* align */ sizeof (vlib_copy_unit_t));
285 vlib_aligned_memcpy (d, src->aligned_buffers, l * sizeof (d[0]));
286 vec_free (src->aligned_buffers);
289 l = vec_len (src->unaligned_buffers);
292 vec_add (dst->unaligned_buffers, src->unaligned_buffers, l);
293 vec_free (src->unaligned_buffers);
298 vlib_buffer_get_free_list_with_size (vlib_main_t * vm, u32 size)
300 vlib_buffer_main_t *bm = vm->buffer_main;
302 size = vlib_buffer_round_size (size);
303 uword *p = hash_get (bm->free_list_by_size, size);
304 return p ? p[0] : ~0;
307 /* Add buffer free list. */
309 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
311 u32 is_public, u32 is_default, u8 * name)
313 vlib_buffer_main_t *bm = vm->buffer_main;
314 vlib_buffer_free_list_t *f;
316 if (!is_default && pool_elts (bm->buffer_free_list_pool) == 0)
318 u32 default_free_free_list_index;
321 default_free_free_list_index =
322 vlib_buffer_create_free_list_helper
324 /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
329 ASSERT (default_free_free_list_index ==
330 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
332 if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
333 return default_free_free_list_index;
336 pool_get_aligned (bm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
338 memset (f, 0, sizeof (f[0]));
339 f->index = f - bm->buffer_free_list_pool;
340 f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
341 f->min_n_buffers_each_physmem_alloc = 16;
342 f->name = clib_mem_is_heap_object (name) ? name : format (0, "%s", name);
344 /* Setup free buffer template. */
345 f->buffer_init_template.free_list_index = f->index;
349 uword *p = hash_get (bm->free_list_by_size, f->n_data_bytes);
351 hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
358 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
365 name = va_format (0, fmt, &va);
368 return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
375 vlib_buffer_get_or_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
378 u32 i = vlib_buffer_get_free_list_with_size (vm, n_data_bytes);
386 name = va_format (0, fmt, &va);
389 i = vlib_buffer_create_free_list_helper (vm, n_data_bytes,
399 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
405 for (i = 0; i < vec_len (f->unaligned_buffers); i++)
407 b = vlib_get_buffer (vm, f->unaligned_buffers[i]);
408 mb = rte_mbuf_from_vlib_buffer (b);
409 ASSERT (rte_mbuf_refcnt_read (mb) == 1);
410 rte_pktmbuf_free (mb);
412 for (i = 0; i < vec_len (f->aligned_buffers); i++)
414 b = vlib_get_buffer (vm, f->aligned_buffers[i]);
415 mb = rte_mbuf_from_vlib_buffer (b);
416 ASSERT (rte_mbuf_refcnt_read (mb) == 1);
417 rte_pktmbuf_free (mb);
420 vec_free (f->unaligned_buffers);
421 vec_free (f->aligned_buffers);
424 /* Add buffer free list. */
426 vlib_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index)
428 vlib_buffer_main_t *bm = vm->buffer_main;
429 vlib_buffer_free_list_t *f;
432 f = vlib_buffer_get_free_list (vm, free_list_index);
434 merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
435 if (merge_index != ~0 && merge_index != free_list_index)
437 merge_free_lists (pool_elt_at_index (bm->buffer_free_list_pool,
441 del_free_list (vm, f);
444 memset (f, 0xab, sizeof (f[0]));
446 pool_put (bm->buffer_free_list_pool, f);
449 /* Make sure free list has at least given number of free buffers. */
451 fill_free_list (vlib_main_t * vm,
452 vlib_buffer_free_list_t * fl, uword min_free_buffers)
457 u32 n_remaining = 0, n_alloc = 0;
458 unsigned socket_id = rte_socket_id ? rte_socket_id () : 0;
459 struct rte_mempool *rmp = vm->buffer_main->pktmbuf_pools[socket_id];
463 if (PREDICT_FALSE (rmp == 0))
468 /* Already have enough free buffers on free list? */
469 n = min_free_buffers - vec_len (fl->aligned_buffers);
471 return min_free_buffers;
473 /* Always allocate round number of buffers. */
474 n = round_pow2 (n, BUFFERS_PER_COPY);
476 /* Always allocate new buffers in reasonably large sized chunks. */
477 n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
479 vec_validate (vm->mbuf_alloc_list, n - 1);
481 if (rte_mempool_get_bulk (rmp, vm->mbuf_alloc_list, n) < 0)
484 _vec_len (vm->mbuf_alloc_list) = n;
486 for (i = 0; i < n; i++)
488 mb = vm->mbuf_alloc_list[i];
490 ASSERT (rte_mbuf_refcnt_read (mb) == 0);
491 rte_mbuf_refcnt_set (mb, 1);
493 mb->data_off = RTE_PKTMBUF_HEADROOM;
496 b = vlib_buffer_from_rte_mbuf (mb);
497 bi = vlib_get_buffer_index (vm, b);
499 vec_add1_aligned (fl->aligned_buffers, bi, sizeof (vlib_copy_unit_t));
503 vlib_buffer_init_for_free_list (b, fl);
505 if (fl->buffer_init_function)
506 fl->buffer_init_function (vm, fl, &bi, 1);
515 copy_alignment (u32 * x)
517 return (pointer_to_uword (x) / sizeof (x[0])) % BUFFERS_PER_COPY;
521 alloc_from_free_list (vlib_main_t * vm,
522 vlib_buffer_free_list_t * free_list,
523 u32 * alloc_buffers, u32 n_alloc_buffers)
527 uword n_unaligned_start, n_unaligned_end, n_filled;
529 n_left = n_alloc_buffers;
531 n_unaligned_start = ((BUFFERS_PER_COPY - copy_alignment (dst))
532 & (BUFFERS_PER_COPY - 1));
534 n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
538 n_left = n_filled < n_left ? n_filled : n_left;
539 n_alloc_buffers = n_left;
541 if (n_unaligned_start >= n_left)
543 n_unaligned_start = n_left;
547 n_unaligned_end = copy_alignment (dst + n_alloc_buffers);
549 fill_unaligned (vm, free_list, n_unaligned_start + n_unaligned_end);
551 u_len = vec_len (free_list->unaligned_buffers);
552 u_src = free_list->unaligned_buffers + u_len - 1;
554 if (n_unaligned_start)
556 uword n_copy = n_unaligned_start;
568 /* Now dst should be aligned. */
570 ASSERT (pointer_to_uword (dst) % sizeof (vlib_copy_unit_t) == 0);
575 vlib_copy_unit_t *d, *s;
578 if (vec_len (free_list->aligned_buffers) <
579 ((n_left / BUFFERS_PER_COPY) * BUFFERS_PER_COPY))
582 n_copy = n_left / BUFFERS_PER_COPY;
583 n_left = n_left % BUFFERS_PER_COPY;
585 /* Remove buffers from aligned free list. */
586 _vec_len (free_list->aligned_buffers) -= n_copy * BUFFERS_PER_COPY;
588 s = (vlib_copy_unit_t *) vec_end (free_list->aligned_buffers);
589 d = (vlib_copy_unit_t *) dst;
591 /* Fast path loop. */
614 /* Unaligned copy. */
615 ASSERT (n_unaligned_end == n_left);
623 if (!free_list->unaligned_buffers)
626 _vec_len (free_list->unaligned_buffers) = u_len;
628 return n_alloc_buffers;
631 /* Allocate a given number of buffers into given array.
632 Returns number actually allocated which will be either zero or
635 vlib_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
637 vlib_buffer_main_t *bm = vm->buffer_main;
639 return alloc_from_free_list
641 pool_elt_at_index (bm->buffer_free_list_pool,
642 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
647 vlib_buffer_alloc_from_free_list (vlib_main_t * vm,
649 u32 n_buffers, u32 free_list_index)
651 vlib_buffer_main_t *bm = vm->buffer_main;
652 vlib_buffer_free_list_t *f;
653 f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
654 return alloc_from_free_list (vm, f, buffers, n_buffers);
658 add_buffer_to_free_list (vlib_main_t * vm,
659 vlib_buffer_free_list_t * f,
660 u32 buffer_index, u8 do_init)
663 b = vlib_get_buffer (vm, buffer_index);
664 if (PREDICT_TRUE (do_init))
665 vlib_buffer_init_for_free_list (b, f);
666 vec_add1_aligned (f->aligned_buffers, buffer_index,
667 sizeof (vlib_copy_unit_t));
670 always_inline vlib_buffer_free_list_t *
671 buffer_get_free_list (vlib_main_t * vm, vlib_buffer_t * b, u32 * index)
673 vlib_buffer_main_t *bm = vm->buffer_main;
676 *index = i = b->free_list_index;
677 return pool_elt_at_index (bm->buffer_free_list_pool, i);
681 vlib_set_buffer_free_callback (vlib_main_t * vm, void *fp)
683 vlib_buffer_main_t *bm = vm->buffer_main;
684 void *rv = bm->buffer_free_callback;
686 bm->buffer_free_callback = fp;
690 static_always_inline void
691 vlib_buffer_free_inline (vlib_main_t * vm,
692 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
694 vlib_buffer_main_t *bm = vm->buffer_main;
695 vlib_buffer_free_list_t *fl;
698 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
699 u32 follow_buffer_next);
701 cb = bm->buffer_free_callback;
703 if (PREDICT_FALSE (cb != 0))
704 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
709 for (i = 0; i < n_buffers; i++)
714 b = vlib_get_buffer (vm, buffers[i]);
716 fl = buffer_get_free_list (vm, b, &fi);
718 /* The only current use of this callback: multicast recycle */
719 if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
723 add_buffer_to_free_list
724 (vm, fl, buffers[i], (b->flags & VLIB_BUFFER_RECYCLE) == 0);
726 for (j = 0; j < vec_len (bm->announce_list); j++)
728 if (fl == bm->announce_list[j])
729 goto already_announced;
731 vec_add1 (bm->announce_list, fl);
737 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0))
739 mb = rte_mbuf_from_vlib_buffer (b);
740 ASSERT (rte_mbuf_refcnt_read (mb) == 1);
741 rte_pktmbuf_free (mb);
745 if (vec_len (bm->announce_list))
747 vlib_buffer_free_list_t *fl;
748 for (i = 0; i < vec_len (bm->announce_list); i++)
750 fl = bm->announce_list[i];
751 fl->buffers_added_to_freelist_function (vm, fl);
753 _vec_len (bm->announce_list) = 0;
758 vlib_buffer_free (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
760 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
765 vlib_buffer_free_no_next (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
767 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
771 /* Copy template packet data into buffers as they are allocated. */
772 __attribute__ ((unused))
774 vlib_packet_template_buffer_init (vlib_main_t * vm,
775 vlib_buffer_free_list_t * fl,
776 u32 * buffers, u32 n_buffers)
778 vlib_packet_template_t *t =
779 uword_to_pointer (fl->buffer_init_function_opaque,
780 vlib_packet_template_t *);
783 for (i = 0; i < n_buffers; i++)
785 vlib_buffer_t *b = vlib_get_buffer (vm, buffers[i]);
786 ASSERT (b->current_length == vec_len (t->packet_data));
787 clib_memcpy (vlib_buffer_get_current (b), t->packet_data,
793 vlib_packet_template_init (vlib_main_t * vm,
794 vlib_packet_template_t * t,
796 uword n_packet_data_bytes,
797 uword min_n_buffers_each_physmem_alloc,
801 __attribute__ ((unused)) u8 *name;
804 name = va_format (0, fmt, &va);
807 vlib_worker_thread_barrier_sync (vm);
808 memset (t, 0, sizeof (t[0]));
810 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
812 vlib_worker_thread_barrier_release (vm);
816 vlib_packet_template_get_packet (vlib_main_t * vm,
817 vlib_packet_template_t * t, u32 * bi_result)
822 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
827 b = vlib_get_buffer (vm, bi);
828 clib_memcpy (vlib_buffer_get_current (b),
829 t->packet_data, vec_len (t->packet_data));
830 b->current_length = vec_len (t->packet_data);
832 /* Fix up mbuf header length fields */
834 mb = rte_mbuf_from_vlib_buffer (b);
835 mb->data_len = b->current_length;
836 mb->pkt_len = b->current_length;
841 /* Append given data to end of buffer, possibly allocating new buffers. */
843 vlib_buffer_add_data (vlib_main_t * vm,
845 u32 buffer_index, void *data, u32 n_data_bytes)
847 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
853 && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
857 n_left = n_data_bytes;
858 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
860 b = vlib_get_buffer (vm, bi);
861 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
863 /* Get to the end of the chain before we try to append data... */
864 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
865 b = vlib_get_buffer (vm, b->next_buffer);
871 ASSERT (n_buffer_bytes >= b->current_length);
873 n_buffer_bytes - (b->current_data + b->current_length);
874 n = clib_min (n_left_this_buffer, n_left);
875 clib_memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
876 b->current_length += n;
883 vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1,
887 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
889 b = vlib_get_buffer (vm, b->next_buffer);
895 clib_error ("out of buffers");
900 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
902 vlib_buffer_t * first,
903 vlib_buffer_t ** last,
904 void *data, u16 data_len)
906 vlib_buffer_t *l = *last;
908 vlib_buffer_free_list_buffer_size (vm, free_list_index);
910 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
913 u16 max = n_buffer_bytes - l->current_length - l->current_data;
917 vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1,
920 *last = l = vlib_buffer_chain_buffer (vm, first, l, l->next_buffer);
921 max = n_buffer_bytes - l->current_length - l->current_data;
924 u16 len = (data_len > max) ? max : data_len;
925 clib_memcpy (vlib_buffer_get_current (l) + l->current_length,
927 vlib_buffer_chain_increase_length (first, l, len);
935 * Fills in the required rte_mbuf fields for chained buffers given a VLIB chain.
938 vlib_buffer_chain_validate (vlib_main_t * vm, vlib_buffer_t * b_first)
940 vlib_buffer_t *b = b_first, *prev = b_first;
941 struct rte_mbuf *mb_prev, *mb, *mb_first;
943 mb_first = rte_mbuf_from_vlib_buffer (b_first);
945 mb_first->pkt_len = mb_first->data_len = b_first->current_length;
946 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
948 b = vlib_get_buffer (vm, b->next_buffer);
949 mb = rte_mbuf_from_vlib_buffer (b);
950 mb_prev = rte_mbuf_from_vlib_buffer (prev);
952 mb_first->pkt_len += b->current_length;
954 mb->data_len = b->current_length;
960 vlib_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
963 vlib_buffer_main_t *bm = vm->buffer_main;
964 vlib_physmem_main_t *vpm = &vm->physmem_main;
965 struct rte_mempool *rmp;
966 uword new_start, new_size;
969 if (!rte_pktmbuf_pool_create)
970 return clib_error_return (0, "not linked with DPDK");
972 vec_validate_aligned (bm->pktmbuf_pools, socket_id, CLIB_CACHE_LINE_BYTES);
974 /* pool already exists, nothing to do */
975 if (bm->pktmbuf_pools[socket_id])
978 u8 *pool_name = format (0, "mbuf_pool_socket%u%c", socket_id, 0);
980 rmp = rte_pktmbuf_pool_create ((char *) pool_name, /* pool name */
981 num_mbufs, /* number of mbufs */
982 512, /* cache size */
983 VLIB_BUFFER_HDR_SIZE, /* priv size */
984 VLIB_BUFFER_PRE_DATA_SIZE + VLIB_BUFFER_DATA_SIZE, /* dataroom size */
985 socket_id); /* cpu socket */
987 vec_free (pool_name);
991 new_start = pointer_to_uword (rmp);
992 new_size = rmp->elt_va_end - new_start;
994 if (vpm->virtual.size > 0)
996 ASSERT (new_start != vpm->virtual.start);
997 if (new_start < vpm->virtual.start)
999 new_size = vpm->virtual.size + vpm->virtual.start - new_start;
1003 new_size += new_start - vpm->virtual.start;
1004 new_start = vpm->virtual.start;
1007 /* check if fits into buffer index range */
1008 if ((u64) new_size > ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
1015 bm->pktmbuf_pools[socket_id] = rmp;
1016 vpm->virtual.start = new_start;
1017 vpm->virtual.size = new_size;
1018 vpm->virtual.end = new_start + new_size;
1022 /* no usable pool for this socket, try to use pool from another one */
1023 for (i = 0; i < vec_len (bm->pktmbuf_pools); i++)
1025 if (bm->pktmbuf_pools[i])
1028 ("WARNING: Failed to allocate mempool for CPU socket %u. "
1029 "Threads running on socket %u will use socket %u mempool.",
1030 socket_id, socket_id, i);
1031 bm->pktmbuf_pools[socket_id] = bm->pktmbuf_pools[i];
1036 return clib_error_return (0, "failed to allocate mempool on socket %u",
1042 vlib_serialize_tx (serialize_main_header_t * m, serialize_stream_t * s)
1045 vlib_serialize_buffer_main_t *sm;
1046 uword n, n_bytes_to_write;
1047 vlib_buffer_t *last;
1049 n_bytes_to_write = s->current_buffer_index;
1051 uword_to_pointer (s->data_function_opaque,
1052 vlib_serialize_buffer_main_t *);
1055 ASSERT (sm->tx.max_n_data_bytes_per_chain > 0);
1056 if (serialize_stream_is_end_of_stream (s)
1057 || sm->tx.n_total_data_bytes + n_bytes_to_write >
1058 sm->tx.max_n_data_bytes_per_chain)
1060 vlib_process_t *p = vlib_get_current_process (vm);
1062 last = vlib_get_buffer (vm, sm->last_buffer);
1063 last->current_length = n_bytes_to_write;
1065 vlib_set_next_frame_buffer (vm, &p->node_runtime, sm->tx.next_index,
1068 sm->first_buffer = sm->last_buffer = ~0;
1069 sm->tx.n_total_data_bytes = 0;
1072 else if (n_bytes_to_write == 0 && s->n_buffer_bytes == 0)
1074 ASSERT (sm->first_buffer == ~0);
1075 ASSERT (sm->last_buffer == ~0);
1077 vlib_buffer_alloc_from_free_list (vm, &sm->first_buffer, 1,
1078 sm->tx.free_list_index);
1082 ("vlib_buffer_alloc_from_free_list fails"));
1083 sm->last_buffer = sm->first_buffer;
1085 vlib_buffer_free_list_buffer_size (vm, sm->tx.free_list_index);
1088 if (n_bytes_to_write > 0)
1090 vlib_buffer_t *prev = vlib_get_buffer (vm, sm->last_buffer);
1092 vlib_buffer_alloc_from_free_list (vm, &sm->last_buffer, 1,
1093 sm->tx.free_list_index);
1097 ("vlib_buffer_alloc_from_free_list fails"));
1098 sm->tx.n_total_data_bytes += n_bytes_to_write;
1099 prev->current_length = n_bytes_to_write;
1100 prev->next_buffer = sm->last_buffer;
1101 prev->flags |= VLIB_BUFFER_NEXT_PRESENT;
1104 if (sm->last_buffer != ~0)
1106 last = vlib_get_buffer (vm, sm->last_buffer);
1107 s->buffer = vlib_buffer_get_current (last);
1108 s->current_buffer_index = 0;
1109 ASSERT (last->current_data == s->current_buffer_index);
1114 vlib_serialize_rx (serialize_main_header_t * m, serialize_stream_t * s)
1117 vlib_serialize_buffer_main_t *sm;
1118 vlib_buffer_t *last;
1121 uword_to_pointer (s->data_function_opaque,
1122 vlib_serialize_buffer_main_t *);
1125 if (serialize_stream_is_end_of_stream (s))
1128 if (sm->last_buffer != ~0)
1130 last = vlib_get_buffer (vm, sm->last_buffer);
1132 if (last->flags & VLIB_BUFFER_NEXT_PRESENT)
1133 sm->last_buffer = last->next_buffer;
1136 vlib_buffer_free (vm, &sm->first_buffer, /* count */ 1);
1137 sm->first_buffer = sm->last_buffer = ~0;
1141 if (sm->last_buffer == ~0)
1143 while (clib_fifo_elts (sm->rx.buffer_fifo) == 0)
1145 sm->rx.ready_one_time_event =
1146 vlib_process_create_one_time_event (vm, vlib_current_process (vm),
1148 vlib_process_wait_for_one_time_event (vm, /* no event data */ 0,
1149 sm->rx.ready_one_time_event);
1152 clib_fifo_sub1 (sm->rx.buffer_fifo, sm->first_buffer);
1153 sm->last_buffer = sm->first_buffer;
1156 ASSERT (sm->last_buffer != ~0);
1158 last = vlib_get_buffer (vm, sm->last_buffer);
1159 s->current_buffer_index = 0;
1160 s->buffer = vlib_buffer_get_current (last);
1161 s->n_buffer_bytes = last->current_length;
1165 serialize_open_vlib_helper (serialize_main_t * m,
1167 vlib_serialize_buffer_main_t * sm, uword is_read)
1169 /* Initialize serialize main but save overflow buffer for re-use between calls. */
1171 u8 *save = m->stream.overflow_buffer;
1172 memset (m, 0, sizeof (m[0]));
1173 m->stream.overflow_buffer = save;
1175 _vec_len (save) = 0;
1178 sm->first_buffer = sm->last_buffer = ~0;
1180 clib_fifo_reset (sm->rx.buffer_fifo);
1182 sm->tx.n_total_data_bytes = 0;
1184 m->header.data_function = is_read ? vlib_serialize_rx : vlib_serialize_tx;
1185 m->stream.data_function_opaque = pointer_to_uword (sm);
1189 serialize_open_vlib_buffer (serialize_main_t * m, vlib_main_t * vm,
1190 vlib_serialize_buffer_main_t * sm)
1192 serialize_open_vlib_helper (m, vm, sm, /* is_read */ 0);
1196 unserialize_open_vlib_buffer (serialize_main_t * m, vlib_main_t * vm,
1197 vlib_serialize_buffer_main_t * sm)
1199 serialize_open_vlib_helper (m, vm, sm, /* is_read */ 1);
1203 serialize_close_vlib_buffer (serialize_main_t * m)
1205 vlib_serialize_buffer_main_t *sm
1206 = uword_to_pointer (m->stream.data_function_opaque,
1207 vlib_serialize_buffer_main_t *);
1208 vlib_buffer_t *last;
1209 serialize_stream_t *s = &m->stream;
1211 last = vlib_get_buffer (sm->vlib_main, sm->last_buffer);
1212 last->current_length = s->current_buffer_index;
1214 if (vec_len (s->overflow_buffer) > 0)
1217 = vlib_buffer_add_data (sm->vlib_main, sm->tx.free_list_index,
1218 sm->last_buffer == ~0 ? 0 : sm->last_buffer,
1220 vec_len (s->overflow_buffer));
1221 _vec_len (s->overflow_buffer) = 0;
1224 return sm->first_buffer;
1228 unserialize_close_vlib_buffer (serialize_main_t * m)
1230 vlib_serialize_buffer_main_t *sm
1231 = uword_to_pointer (m->stream.data_function_opaque,
1232 vlib_serialize_buffer_main_t *);
1233 if (sm->first_buffer != ~0)
1234 vlib_buffer_free_one (sm->vlib_main, sm->first_buffer);
1235 clib_fifo_reset (sm->rx.buffer_fifo);
1236 if (m->stream.overflow_buffer)
1237 _vec_len (m->stream.overflow_buffer) = 0;
1241 format_vlib_buffer_free_list (u8 * s, va_list * va)
1243 vlib_buffer_free_list_t *f = va_arg (*va, vlib_buffer_free_list_t *);
1244 u32 threadnum = va_arg (*va, u32);
1245 uword bytes_alloc, bytes_free, n_free, size;
1248 return format (s, "%=7s%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
1249 "Thread", "Name", "Index", "Size", "Alloc", "Free",
1252 size = sizeof (vlib_buffer_t) + f->n_data_bytes;
1253 n_free = vec_len (f->aligned_buffers) + vec_len (f->unaligned_buffers);
1254 bytes_alloc = size * f->n_alloc;
1255 bytes_free = size * n_free;
1257 s = format (s, "%7d%30s%12d%12d%=12U%=12U%=12d%=12d",
1259 f->name, f->index, f->n_data_bytes,
1260 format_memory_size, bytes_alloc,
1261 format_memory_size, bytes_free, f->n_alloc, n_free);
1266 static clib_error_t *
1267 show_buffers (vlib_main_t * vm,
1268 unformat_input_t * input, vlib_cli_command_t * cmd)
1270 vlib_buffer_main_t *bm;
1271 vlib_buffer_free_list_t *f;
1272 vlib_main_t *curr_vm;
1275 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0, 0);
1279 curr_vm = vec_len (vlib_mains) ? vlib_mains[vm_index] : vm;
1280 bm = curr_vm->buffer_main;
1283 pool_foreach (f, bm->buffer_free_list_pool, ({
1284 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f, vm_index);
1290 while (vm_index < vec_len (vlib_mains));
1296 VLIB_CLI_COMMAND (show_buffers_command, static) = {
1297 .path = "show buffers",
1298 .short_help = "Show packet buffer allocation",
1299 .function = show_buffers,
1305 u32 *vlib_buffer_state_validation_lock;
1306 uword *vlib_buffer_state_validation_hash;
1307 void *vlib_buffer_state_heap;
1309 static clib_error_t *
1310 buffer_state_validation_init (vlib_main_t * vm)
1314 vlib_buffer_state_heap = mheap_alloc (0, 10 << 20);
1316 oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
1318 vlib_buffer_state_validation_hash = hash_create (0, sizeof (uword));
1319 vec_validate_aligned (vlib_buffer_state_validation_lock, 0,
1320 CLIB_CACHE_LINE_BYTES);
1321 clib_mem_set_heap (oldheap);
1325 VLIB_INIT_FUNCTION (buffer_state_validation_init);
1329 * fd.io coding-style-patch-verification: ON
1332 * eval: (c-set-style "gnu")