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
73 uword vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm, vlib_buffer_t * b_first)
75 vlib_buffer_t * b = b_first;
76 uword l_first = b_first->current_length;
78 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
80 b = vlib_get_buffer (vm, b->next_buffer);
81 l += b->current_length;
83 b_first->total_length_not_including_first_buffer = l;
84 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
88 u8 * format_vlib_buffer (u8 * s, va_list * args)
90 vlib_buffer_t * b = va_arg (*args, vlib_buffer_t *);
91 uword indent = format_get_indent (s);
93 s = format (s, "current data %d, length %d, free-list %d",
94 b->current_data, b->current_length,
97 if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
98 s = format (s, ", totlen-nifb %d",
99 b->total_length_not_including_first_buffer);
101 if (b->flags & VLIB_BUFFER_IS_TRACED)
102 s = format (s, ", trace 0x%x", b->trace_index);
104 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
106 vlib_main_t * vm = vlib_get_main();
107 u32 next_buffer = b->next_buffer;
108 b = vlib_get_buffer(vm, next_buffer);
110 s = format (s, "\n%Unext-buffer 0x%x, segment length %d",
111 format_white_space, indent, next_buffer, b->current_length);
118 u8 * format_vlib_buffer_and_data (u8 * s, va_list * args)
120 vlib_buffer_t * b = va_arg (*args, vlib_buffer_t *);
122 s = format (s, "%U, %U",
123 format_vlib_buffer, b,
124 format_hex_bytes, vlib_buffer_get_current (b), 64);
129 u8 * format_vlib_buffer_contents (u8 * s, va_list * va)
131 vlib_main_t * vm = va_arg (*va, vlib_main_t *);
132 vlib_buffer_t * b = va_arg (*va, vlib_buffer_t *);
136 vec_add (s, vlib_buffer_get_current (b),
138 if (! (b->flags & VLIB_BUFFER_NEXT_PRESENT))
140 b = vlib_get_buffer (vm, b->next_buffer);
146 vlib_main_t **vlib_mains;
148 /* Aligned copy routine. */
150 vlib_aligned_memcpy (void * _dst, void * _src, int n_bytes)
152 vlib_copy_unit_t * dst = _dst;
153 vlib_copy_unit_t * src = _src;
155 /* Arguments must be naturally aligned. */
156 ASSERT (pointer_to_uword (dst) % sizeof (dst[0]) == 0);
157 ASSERT (pointer_to_uword (src) % sizeof (src[0]) == 0);
158 ASSERT (n_bytes % sizeof (dst[0]) == 0);
160 if (4 * sizeof (dst[0]) == CLIB_CACHE_LINE_BYTES)
162 CLIB_PREFETCH (dst + 0, 4 * sizeof (dst[0]), WRITE);
163 CLIB_PREFETCH (src + 0, 4 * sizeof (src[0]), READ);
165 while (n_bytes >= 4 * sizeof (dst[0]))
169 n_bytes -= 4 * sizeof (dst[0]);
170 CLIB_PREFETCH (dst, 4 * sizeof (dst[0]), WRITE);
171 CLIB_PREFETCH (src, 4 * sizeof (src[0]), READ);
178 else if (8 * sizeof (dst[0]) == CLIB_CACHE_LINE_BYTES)
180 CLIB_PREFETCH (dst + 0, 8 * sizeof (dst[0]), WRITE);
181 CLIB_PREFETCH (src + 0, 8 * sizeof (src[0]), READ);
183 while (n_bytes >= 8 * sizeof (dst[0]))
187 n_bytes -= 8 * sizeof (dst[0]);
188 CLIB_PREFETCH (dst, 8 * sizeof (dst[0]), WRITE);
189 CLIB_PREFETCH (src, 8 * sizeof (src[0]), READ);
201 /* Cache line size unknown: fall back to slow version. */;
206 n_bytes -= 1 * sizeof (dst[0]);
210 #define BUFFERS_PER_COPY (sizeof (vlib_copy_unit_t) / sizeof (u32))
212 /* Make sure we have at least given number of unaligned buffers. */
214 fill_unaligned (vlib_main_t * vm,
215 vlib_buffer_free_list_t * free_list,
216 uword n_unaligned_buffers)
218 word la = vec_len (free_list->aligned_buffers);
219 word lu = vec_len (free_list->unaligned_buffers);
221 /* Aligned come in aligned copy-sized chunks. */
222 ASSERT (la % BUFFERS_PER_COPY == 0);
224 ASSERT (la >= n_unaligned_buffers);
226 while (lu < n_unaligned_buffers)
228 /* Copy 4 buffers from end of aligned vector to unaligned vector. */
229 vec_add (free_list->unaligned_buffers,
230 free_list->aligned_buffers + la - BUFFERS_PER_COPY,
232 la -= BUFFERS_PER_COPY;
233 lu += BUFFERS_PER_COPY;
235 _vec_len (free_list->aligned_buffers) = la;
238 /* After free aligned buffers may not contain even sized chunks. */
240 trim_aligned (vlib_buffer_free_list_t * f)
244 /* Add unaligned to aligned before trim. */
245 l = vec_len (f->unaligned_buffers);
248 vec_add_aligned (f->aligned_buffers, f->unaligned_buffers, l,
249 /* align */ sizeof (vlib_copy_unit_t));
251 _vec_len (f->unaligned_buffers) = 0;
254 /* Remove unaligned buffers from end of aligned vector and save for next trim. */
255 l = vec_len (f->aligned_buffers);
256 n_trim = l % BUFFERS_PER_COPY;
259 /* Trim aligned -> unaligned. */
260 vec_add (f->unaligned_buffers, f->aligned_buffers + l - n_trim, n_trim);
262 /* Remove from aligned. */
263 _vec_len (f->aligned_buffers) = l - n_trim;
268 merge_free_lists (vlib_buffer_free_list_t * dst,
269 vlib_buffer_free_list_t * src)
277 l = vec_len (src->aligned_buffers);
280 vec_add2_aligned (dst->aligned_buffers, d, l,
281 /* align */ sizeof (vlib_copy_unit_t));
282 vlib_aligned_memcpy (d, src->aligned_buffers, l * sizeof (d[0]));
283 vec_free (src->aligned_buffers);
286 l = vec_len (src->unaligned_buffers);
289 vec_add (dst->unaligned_buffers, src->unaligned_buffers, l);
290 vec_free (src->unaligned_buffers);
295 vlib_buffer_get_free_list_with_size (vlib_main_t * vm, u32 size)
297 vlib_buffer_main_t * bm = vm->buffer_main;
299 size = vlib_buffer_round_size (size);
300 uword * p = hash_get (bm->free_list_by_size, size);
301 return p ? p[0] : ~0;
304 /* Add buffer free list. */
306 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
312 vlib_buffer_main_t * bm = vm->buffer_main;
313 vlib_buffer_free_list_t * f;
315 if (! is_default && pool_elts (bm->buffer_free_list_pool) == 0)
317 u32 default_free_free_list_index;
319 default_free_free_list_index =
320 vlib_buffer_create_free_list_helper (vm,
321 /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
325 ASSERT (default_free_free_list_index == VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
327 if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
328 return default_free_free_list_index;
331 pool_get_aligned (bm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
333 memset (f, 0, sizeof (f[0]));
334 f->index = f - bm->buffer_free_list_pool;
335 f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
336 f->min_n_buffers_each_physmem_alloc = 16;
337 f->name = clib_mem_is_heap_object (name) ? name : format (0, "%s", name);
339 /* Setup free buffer template. */
340 f->buffer_init_template.free_list_index = f->index;
344 uword * p = hash_get (bm->free_list_by_size, f->n_data_bytes);
346 hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
352 u32 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
359 name = va_format (0, fmt, &va);
362 return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
368 u32 vlib_buffer_get_or_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
371 u32 i = vlib_buffer_get_free_list_with_size (vm, n_data_bytes);
379 name = va_format (0, fmt, &va);
382 i = vlib_buffer_create_free_list_helper (vm, n_data_bytes,
392 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
398 for (i = 0; i < vec_len (f->unaligned_buffers); i++) {
399 b = vlib_get_buffer (vm, f->unaligned_buffers[i]);
400 mb = rte_mbuf_from_vlib_buffer(b);
401 ASSERT(rte_mbuf_refcnt_read(mb) == 1);
402 rte_pktmbuf_free (mb);
404 for (i = 0; i < vec_len (f->aligned_buffers); i++) {
405 b = vlib_get_buffer (vm, f->aligned_buffers[i]);
406 mb = rte_mbuf_from_vlib_buffer(b);
407 ASSERT(rte_mbuf_refcnt_read(mb) == 1);
408 rte_pktmbuf_free (mb);
411 vec_free (f->unaligned_buffers);
412 vec_free (f->aligned_buffers);
415 /* Add buffer free list. */
416 void vlib_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index)
418 vlib_buffer_main_t * bm = vm->buffer_main;
419 vlib_buffer_free_list_t * f;
422 f = vlib_buffer_get_free_list (vm, free_list_index);
424 merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
425 if (merge_index != ~0 && merge_index != free_list_index)
427 merge_free_lists (pool_elt_at_index (bm->buffer_free_list_pool,
431 del_free_list (vm, f);
434 memset (f, 0xab, sizeof (f[0]));
436 pool_put (bm->buffer_free_list_pool, f);
439 /* Make sure free list has at least given number of free buffers. */
441 fill_free_list (vlib_main_t * vm,
442 vlib_buffer_free_list_t * fl,
443 uword min_free_buffers)
448 u32 n_remaining = 0, n_alloc = 0;
449 unsigned socket_id = rte_socket_id ? rte_socket_id() : 0;
450 struct rte_mempool *rmp = vm->buffer_main->pktmbuf_pools[socket_id];
454 if (PREDICT_FALSE(rmp == 0))
459 /* Already have enough free buffers on free list? */
460 n = min_free_buffers - vec_len (fl->aligned_buffers);
462 return min_free_buffers;
464 /* Always allocate round number of buffers. */
465 n = round_pow2 (n, BUFFERS_PER_COPY);
467 /* Always allocate new buffers in reasonably large sized chunks. */
468 n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
470 vec_validate (vm->mbuf_alloc_list, n-1);
472 if (rte_mempool_get_bulk (rmp, vm->mbuf_alloc_list, n) < 0)
475 _vec_len (vm->mbuf_alloc_list) = n;
477 for (i = 0; i < n; i++)
479 mb = vm->mbuf_alloc_list[i];
481 ASSERT(rte_mbuf_refcnt_read(mb) == 0);
482 rte_mbuf_refcnt_set(mb, 1);
484 mb->data_off = RTE_PKTMBUF_HEADROOM;
487 b = vlib_buffer_from_rte_mbuf(mb);
488 bi = vlib_get_buffer_index (vm, b);
490 vec_add1_aligned (fl->aligned_buffers, bi, sizeof (vlib_copy_unit_t));
494 vlib_buffer_init_for_free_list (b, fl);
496 if (fl->buffer_init_function)
497 fl->buffer_init_function (vm, fl, &bi, 1);
506 copy_alignment (u32 * x)
507 { return (pointer_to_uword (x) / sizeof (x[0])) % BUFFERS_PER_COPY; }
510 alloc_from_free_list (vlib_main_t * vm,
511 vlib_buffer_free_list_t * free_list,
517 uword n_unaligned_start, n_unaligned_end, n_filled;
519 n_left = n_alloc_buffers;
521 n_unaligned_start = ((BUFFERS_PER_COPY - copy_alignment (dst))
522 & (BUFFERS_PER_COPY - 1));
524 n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
528 n_left = n_filled < n_left ? n_filled : n_left;
529 n_alloc_buffers = n_left;
531 if (n_unaligned_start >= n_left)
533 n_unaligned_start = n_left;
537 n_unaligned_end = copy_alignment (dst + n_alloc_buffers);
539 fill_unaligned (vm, free_list, n_unaligned_start + n_unaligned_end);
541 u_len = vec_len (free_list->unaligned_buffers);
542 u_src = free_list->unaligned_buffers + u_len - 1;
544 if (n_unaligned_start)
546 uword n_copy = n_unaligned_start;
558 /* Now dst should be aligned. */
560 ASSERT (pointer_to_uword (dst) % sizeof (vlib_copy_unit_t) == 0);
565 vlib_copy_unit_t * d, * s;
568 if (vec_len(free_list->aligned_buffers) < ((n_left/BUFFERS_PER_COPY)*BUFFERS_PER_COPY))
571 n_copy = n_left / BUFFERS_PER_COPY;
572 n_left = n_left % BUFFERS_PER_COPY;
574 /* Remove buffers from aligned free list. */
575 _vec_len (free_list->aligned_buffers) -= n_copy * BUFFERS_PER_COPY;
577 s = (vlib_copy_unit_t *) vec_end (free_list->aligned_buffers);
578 d = (vlib_copy_unit_t *) dst;
580 /* Fast path loop. */
603 /* Unaligned copy. */
604 ASSERT (n_unaligned_end == n_left);
612 if (! free_list->unaligned_buffers)
615 _vec_len (free_list->unaligned_buffers) = u_len;
617 return n_alloc_buffers;
620 /* Allocate a given number of buffers into given array.
621 Returns number actually allocated which will be either zero or
623 u32 vlib_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
625 vlib_buffer_main_t * bm = vm->buffer_main;
627 return alloc_from_free_list
629 pool_elt_at_index (bm->buffer_free_list_pool,
630 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
634 u32 vlib_buffer_alloc_from_free_list (vlib_main_t * vm,
639 vlib_buffer_main_t * bm = vm->buffer_main;
640 vlib_buffer_free_list_t * f;
641 f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
642 return alloc_from_free_list (vm, f, buffers, n_buffers);
646 add_buffer_to_free_list (vlib_main_t * vm,
647 vlib_buffer_free_list_t * f,
648 u32 buffer_index, u8 do_init)
651 b = vlib_get_buffer (vm, buffer_index);
652 if (PREDICT_TRUE(do_init))
653 vlib_buffer_init_for_free_list (b, f);
654 vec_add1_aligned (f->aligned_buffers, buffer_index, sizeof (vlib_copy_unit_t));
657 always_inline vlib_buffer_free_list_t *
658 buffer_get_free_list (vlib_main_t * vm, vlib_buffer_t * b, u32 * index)
660 vlib_buffer_main_t * bm = vm->buffer_main;
663 *index = i = b->free_list_index;
664 return pool_elt_at_index (bm->buffer_free_list_pool, i);
667 void *vlib_set_buffer_free_callback (vlib_main_t *vm, void *fp)
669 vlib_buffer_main_t * bm = vm->buffer_main;
670 void * rv = bm->buffer_free_callback;
672 bm->buffer_free_callback = fp;
676 static_always_inline void
677 vlib_buffer_free_inline (vlib_main_t * vm,
680 u32 follow_buffer_next)
682 vlib_buffer_main_t * bm = vm->buffer_main;
683 vlib_buffer_free_list_t * fl;
686 u32 (*cb)(vlib_main_t * vm, u32 * buffers, u32 n_buffers,
687 u32 follow_buffer_next);
689 cb = bm->buffer_free_callback;
691 if (PREDICT_FALSE (cb != 0))
692 n_buffers = (*cb)(vm, buffers, n_buffers, follow_buffer_next);
697 for (i = 0; i < n_buffers; i++)
700 struct rte_mbuf * mb;
702 b = vlib_get_buffer (vm, buffers[i]);
704 fl = buffer_get_free_list (vm, b, &fi);
706 /* The only current use of this callback: multicast recycle */
707 if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
711 add_buffer_to_free_list
713 (b->flags & VLIB_BUFFER_RECYCLE) == 0);
715 for (j = 0; j < vec_len (bm->announce_list); j++)
717 if (fl == bm->announce_list[j])
718 goto already_announced;
720 vec_add1 (bm->announce_list, fl);
726 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0))
728 mb = rte_mbuf_from_vlib_buffer(b);
729 ASSERT(rte_mbuf_refcnt_read(mb) == 1);
730 rte_pktmbuf_free (mb);
734 if (vec_len(bm->announce_list))
736 vlib_buffer_free_list_t * fl;
737 for (i = 0; i < vec_len (bm->announce_list); i++)
739 fl = bm->announce_list[i];
740 fl->buffers_added_to_freelist_function (vm, fl);
742 _vec_len(bm->announce_list) = 0;
746 void vlib_buffer_free (vlib_main_t * vm,
750 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */ 1);
753 void vlib_buffer_free_no_next (vlib_main_t * vm,
757 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */ 0);
760 /* Copy template packet data into buffers as they are allocated. */
761 __attribute__((unused)) static void
762 vlib_packet_template_buffer_init (vlib_main_t * vm,
763 vlib_buffer_free_list_t * fl,
767 vlib_packet_template_t * t = uword_to_pointer (fl->buffer_init_function_opaque,
768 vlib_packet_template_t *);
771 for (i = 0; i < n_buffers; i++)
773 vlib_buffer_t * b = vlib_get_buffer (vm, buffers[i]);
774 ASSERT (b->current_length == vec_len (t->packet_data));
775 clib_memcpy (vlib_buffer_get_current (b), t->packet_data, b->current_length);
779 void vlib_packet_template_init (vlib_main_t * vm,
780 vlib_packet_template_t * t,
782 uword n_packet_data_bytes,
783 uword min_n_buffers_each_physmem_alloc,
788 __attribute__((unused)) u8 * name;
791 name = va_format (0, fmt, &va);
794 vlib_worker_thread_barrier_sync(vm);
795 memset (t, 0, sizeof (t[0]));
797 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
799 vlib_worker_thread_barrier_release(vm);
803 vlib_packet_template_get_packet (vlib_main_t * vm,
804 vlib_packet_template_t * t,
810 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
815 b = vlib_get_buffer (vm, bi);
816 clib_memcpy (vlib_buffer_get_current (b),
817 t->packet_data, vec_len(t->packet_data));
818 b->current_length = vec_len(t->packet_data);
820 /* Fix up mbuf header length fields */
821 struct rte_mbuf * mb;
822 mb = rte_mbuf_from_vlib_buffer(b);
823 mb->data_len = b->current_length;
824 mb->pkt_len = b->current_length;
829 /* Append given data to end of buffer, possibly allocating new buffers. */
830 u32 vlib_buffer_add_data (vlib_main_t * vm,
833 void * data, u32 n_data_bytes)
835 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
841 && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
845 n_left = n_data_bytes;
846 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
848 b = vlib_get_buffer (vm, bi);
849 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
851 /* Get to the end of the chain before we try to append data...*/
852 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
853 b = vlib_get_buffer (vm, b->next_buffer);
859 ASSERT (n_buffer_bytes >= b->current_length);
860 n_left_this_buffer = n_buffer_bytes - (b->current_data + b->current_length);
861 n = clib_min (n_left_this_buffer, n_left);
862 clib_memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
863 b->current_length += n;
869 if (1 != vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1, free_list_index))
872 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
874 b = vlib_get_buffer (vm, b->next_buffer);
880 clib_error ("out of buffers");
885 vlib_buffer_chain_append_data_with_alloc(vlib_main_t *vm,
887 vlib_buffer_t *first,
888 vlib_buffer_t **last,
889 void * data, u16 data_len) {
890 vlib_buffer_t *l = *last;
891 u32 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
893 ASSERT(n_buffer_bytes >= l->current_length + l->current_data);
895 u16 max = n_buffer_bytes - l->current_length - l->current_data;
897 if (1 != vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1, free_list_index))
899 *last = l = vlib_buffer_chain_buffer(vm, first, l, l->next_buffer);
900 max = n_buffer_bytes - l->current_length - l->current_data;
903 u16 len = (data_len > max)?max:data_len;
904 clib_memcpy(vlib_buffer_get_current (l) + l->current_length, data + copied, len);
905 vlib_buffer_chain_increase_length(first, l, len);
913 * Fills in the required rte_mbuf fields for chained buffers given a VLIB chain.
915 void vlib_buffer_chain_validate (vlib_main_t * vm, vlib_buffer_t * b_first)
917 vlib_buffer_t *b = b_first, *prev = b_first;
918 struct rte_mbuf *mb_prev, *mb, *mb_first;
920 mb_first = rte_mbuf_from_vlib_buffer(b_first);
922 mb_first->pkt_len = mb_first->data_len = b_first->current_length;
923 while (b->flags & VLIB_BUFFER_NEXT_PRESENT) {
924 b = vlib_get_buffer(vm, b->next_buffer);
925 mb = rte_mbuf_from_vlib_buffer(b);
926 mb_prev = rte_mbuf_from_vlib_buffer(prev);
928 mb_first->pkt_len += b->current_length;
930 mb->data_len = b->current_length;
936 vlib_buffer_pool_create(vlib_main_t * vm, unsigned num_mbufs,
939 vlib_buffer_main_t * bm = vm->buffer_main;
940 vlib_physmem_main_t * vpm = &vm->physmem_main;
941 struct rte_mempool * rmp;
942 uword new_start, new_size;
945 if (!rte_pktmbuf_pool_create)
946 return clib_error_return (0, "not linked with DPDK");
948 vec_validate_aligned(bm->pktmbuf_pools, socket_id, CLIB_CACHE_LINE_BYTES);
950 /* pool already exists, nothing to do */
951 if (bm->pktmbuf_pools[socket_id])
954 u8 * pool_name = format(0, "mbuf_pool_socket%u%c",socket_id, 0);
956 rmp = rte_pktmbuf_pool_create((char *) pool_name, /* pool name */
957 num_mbufs, /* number of mbufs */
958 512, /* cache size */
959 VLIB_BUFFER_HDR_SIZE, /* priv size */
960 VLIB_BUFFER_PRE_DATA_SIZE
961 + VLIB_BUFFER_DATA_SIZE, /* dataroom size */
962 socket_id); /* cpu socket */
968 new_start = pointer_to_uword(rmp);
969 new_size = rmp->elt_va_end - new_start;
971 if (vpm->virtual.size > 0)
973 ASSERT(new_start != vpm->virtual.start);
974 if (new_start < vpm->virtual.start)
976 new_size = vpm->virtual.size + vpm->virtual.start - new_start;
980 new_size += new_start - vpm->virtual.start;
981 new_start = vpm->virtual.start;
984 /* check if fits into buffer index range */
985 if ( (u64)new_size > ( (u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
992 bm->pktmbuf_pools[socket_id] = rmp;
993 vpm->virtual.start = new_start;
994 vpm->virtual.size = new_size;
995 vpm->virtual.end = new_start + new_size;
999 /* no usable pool for this socket, try to use pool from another one */
1000 for (i = 0; i < vec_len(bm->pktmbuf_pools); i++)
1002 if(bm->pktmbuf_pools[i])
1004 clib_warning("WARNING: Failed to allocate mempool for CPU socket %u. "
1005 "Threads running on socket %u will use socket %u mempool.",
1006 socket_id, socket_id, i);
1007 bm->pktmbuf_pools[socket_id] = bm->pktmbuf_pools[i];
1012 return clib_error_return (0, "failed to allocate mempool on socket %u",
1017 static void vlib_serialize_tx (serialize_main_header_t * m, serialize_stream_t * s)
1020 vlib_serialize_buffer_main_t * sm;
1021 uword n, n_bytes_to_write;
1022 vlib_buffer_t * last;
1024 n_bytes_to_write = s->current_buffer_index;
1025 sm = uword_to_pointer (s->data_function_opaque, vlib_serialize_buffer_main_t *);
1028 ASSERT (sm->tx.max_n_data_bytes_per_chain > 0);
1029 if (serialize_stream_is_end_of_stream (s)
1030 || sm->tx.n_total_data_bytes + n_bytes_to_write > sm->tx.max_n_data_bytes_per_chain)
1032 vlib_process_t * p = vlib_get_current_process (vm);
1034 last = vlib_get_buffer (vm, sm->last_buffer);
1035 last->current_length = n_bytes_to_write;
1037 vlib_set_next_frame_buffer (vm, &p->node_runtime, sm->tx.next_index, sm->first_buffer);
1039 sm->first_buffer = sm->last_buffer = ~0;
1040 sm->tx.n_total_data_bytes = 0;
1043 else if (n_bytes_to_write == 0 && s->n_buffer_bytes == 0)
1045 ASSERT (sm->first_buffer == ~0);
1046 ASSERT (sm->last_buffer == ~0);
1047 n = vlib_buffer_alloc_from_free_list (vm, &sm->first_buffer, 1, sm->tx.free_list_index);
1049 serialize_error (m, clib_error_create ("vlib_buffer_alloc_from_free_list fails"));
1050 sm->last_buffer = sm->first_buffer;
1051 s->n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, sm->tx.free_list_index);
1054 if (n_bytes_to_write > 0)
1056 vlib_buffer_t * prev = vlib_get_buffer (vm, sm->last_buffer);
1057 n = vlib_buffer_alloc_from_free_list (vm, &sm->last_buffer, 1, sm->tx.free_list_index);
1059 serialize_error (m, clib_error_create ("vlib_buffer_alloc_from_free_list fails"));
1060 sm->tx.n_total_data_bytes += n_bytes_to_write;
1061 prev->current_length = n_bytes_to_write;
1062 prev->next_buffer = sm->last_buffer;
1063 prev->flags |= VLIB_BUFFER_NEXT_PRESENT;
1066 if (sm->last_buffer != ~0)
1068 last = vlib_get_buffer (vm, sm->last_buffer);
1069 s->buffer = vlib_buffer_get_current (last);
1070 s->current_buffer_index = 0;
1071 ASSERT (last->current_data == s->current_buffer_index);
1075 static void vlib_serialize_rx (serialize_main_header_t * m, serialize_stream_t * s)
1078 vlib_serialize_buffer_main_t * sm;
1079 vlib_buffer_t * last;
1081 sm = uword_to_pointer (s->data_function_opaque, vlib_serialize_buffer_main_t *);
1084 if (serialize_stream_is_end_of_stream (s))
1087 if (sm->last_buffer != ~0)
1089 last = vlib_get_buffer (vm, sm->last_buffer);
1091 if (last->flags & VLIB_BUFFER_NEXT_PRESENT)
1092 sm->last_buffer = last->next_buffer;
1095 vlib_buffer_free (vm, &sm->first_buffer, /* count */ 1);
1096 sm->first_buffer = sm->last_buffer = ~0;
1100 if (sm->last_buffer == ~0)
1102 while (clib_fifo_elts (sm->rx.buffer_fifo) == 0)
1104 sm->rx.ready_one_time_event = vlib_process_create_one_time_event (vm, vlib_current_process (vm), ~0);
1105 vlib_process_wait_for_one_time_event (vm, /* no event data */ 0, sm->rx.ready_one_time_event);
1108 clib_fifo_sub1 (sm->rx.buffer_fifo, sm->first_buffer);
1109 sm->last_buffer = sm->first_buffer;
1112 ASSERT (sm->last_buffer != ~0);
1114 last = vlib_get_buffer (vm, sm->last_buffer);
1115 s->current_buffer_index = 0;
1116 s->buffer = vlib_buffer_get_current (last);
1117 s->n_buffer_bytes = last->current_length;
1121 serialize_open_vlib_helper (serialize_main_t * m,
1123 vlib_serialize_buffer_main_t * sm,
1126 /* Initialize serialize main but save overflow buffer for re-use between calls. */
1128 u8 * save = m->stream.overflow_buffer;
1129 memset (m, 0, sizeof (m[0]));
1130 m->stream.overflow_buffer = save;
1132 _vec_len (save) = 0;
1135 sm->first_buffer = sm->last_buffer = ~0;
1137 clib_fifo_reset (sm->rx.buffer_fifo);
1139 sm->tx.n_total_data_bytes = 0;
1141 m->header.data_function = is_read ? vlib_serialize_rx : vlib_serialize_tx;
1142 m->stream.data_function_opaque = pointer_to_uword (sm);
1145 void serialize_open_vlib_buffer (serialize_main_t * m, vlib_main_t * vm, vlib_serialize_buffer_main_t * sm)
1146 { serialize_open_vlib_helper (m, vm, sm, /* is_read */ 0); }
1148 void unserialize_open_vlib_buffer (serialize_main_t * m, vlib_main_t * vm, vlib_serialize_buffer_main_t * sm)
1149 { serialize_open_vlib_helper (m, vm, sm, /* is_read */ 1); }
1151 u32 serialize_close_vlib_buffer (serialize_main_t * m)
1153 vlib_serialize_buffer_main_t * sm
1154 = uword_to_pointer (m->stream.data_function_opaque, vlib_serialize_buffer_main_t *);
1155 vlib_buffer_t * last;
1156 serialize_stream_t * s = &m->stream;
1158 last = vlib_get_buffer (sm->vlib_main, sm->last_buffer);
1159 last->current_length = s->current_buffer_index;
1161 if (vec_len (s->overflow_buffer) > 0)
1164 = vlib_buffer_add_data (sm->vlib_main, sm->tx.free_list_index,
1165 sm->last_buffer == ~0 ? 0 : sm->last_buffer,
1167 vec_len (s->overflow_buffer));
1168 _vec_len (s->overflow_buffer) = 0;
1171 return sm->first_buffer;
1174 void unserialize_close_vlib_buffer (serialize_main_t * m)
1176 vlib_serialize_buffer_main_t * sm
1177 = uword_to_pointer (m->stream.data_function_opaque, vlib_serialize_buffer_main_t *);
1178 if (sm->first_buffer != ~0)
1179 vlib_buffer_free_one (sm->vlib_main, sm->first_buffer);
1180 clib_fifo_reset (sm->rx.buffer_fifo);
1181 if (m->stream.overflow_buffer)
1182 _vec_len (m->stream.overflow_buffer) = 0;
1185 static u8 * format_vlib_buffer_free_list (u8 * s, va_list * va)
1187 vlib_buffer_free_list_t * f = va_arg (*va, vlib_buffer_free_list_t *);
1188 u32 threadnum= va_arg (*va, u32);
1189 uword bytes_alloc, bytes_free, n_free, size;
1192 return format (s, "%=7s%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
1193 "Thread", "Name", "Index", "Size", "Alloc", "Free", "#Alloc", "#Free");
1195 size = sizeof (vlib_buffer_t) + f->n_data_bytes;
1196 n_free = vec_len (f->aligned_buffers) + vec_len (f->unaligned_buffers);
1197 bytes_alloc = size * f->n_alloc;
1198 bytes_free = size * n_free;
1200 s = format (s, "%7d%30s%12d%12d%=12U%=12U%=12d%=12d",
1202 f->name, f->index, f->n_data_bytes,
1203 format_memory_size, bytes_alloc,
1204 format_memory_size, bytes_free,
1205 f->n_alloc, n_free);
1210 static clib_error_t *
1211 show_buffers (vlib_main_t * vm,
1212 unformat_input_t * input,
1213 vlib_cli_command_t * cmd)
1215 vlib_buffer_main_t * bm;
1216 vlib_buffer_free_list_t * f;
1217 vlib_main_t *curr_vm;
1220 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0, 0);
1223 curr_vm = vec_len(vlib_mains) ? vlib_mains[vm_index] : vm;
1224 bm = curr_vm->buffer_main;
1226 pool_foreach (f, bm->buffer_free_list_pool, ({
1227 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f, vm_index);
1231 } while (vm_index < vec_len(vlib_mains));
1236 VLIB_CLI_COMMAND (show_buffers_command, static) = {
1237 .path = "show buffers",
1238 .short_help = "Show packet buffer allocation",
1239 .function = show_buffers,
1244 u32 * vlib_buffer_state_validation_lock;
1245 uword * vlib_buffer_state_validation_hash;
1246 void * vlib_buffer_state_heap;
1248 static clib_error_t *
1249 buffer_state_validation_init (vlib_main_t * vm)
1253 vlib_buffer_state_heap = mheap_alloc (0, 10<<20);
1255 oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
1257 vlib_buffer_state_validation_hash = hash_create (0, sizeof(uword));
1258 vec_validate_aligned (vlib_buffer_state_validation_lock, 0,
1259 CLIB_CACHE_LINE_BYTES);
1260 clib_mem_set_heap (oldheap);
1264 VLIB_INIT_FUNCTION (buffer_state_validation_init);