2 * Copyright (c) 2017 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.
43 * Allocate/free network buffers.
46 #include <rte_config.h>
48 #include <rte_common.h>
50 #include <rte_memory.h>
51 #include <rte_memzone.h>
52 #include <rte_tailq.h>
54 #include <rte_per_lcore.h>
55 #include <rte_launch.h>
56 #include <rte_atomic.h>
57 #include <rte_cycles.h>
58 #include <rte_prefetch.h>
59 #include <rte_lcore.h>
60 #include <rte_per_lcore.h>
61 #include <rte_branch_prediction.h>
62 #include <rte_interrupts.h>
64 #include <rte_random.h>
65 #include <rte_debug.h>
66 #include <rte_ether.h>
67 #include <rte_ethdev.h>
69 #include <rte_mempool.h>
71 #include <rte_version.h>
73 #include <vlib/vlib.h>
74 #include <vnet/vnet.h>
75 #include <vnet/devices/dpdk/dpdk.h>
76 #include <vnet/devices/dpdk/dpdk_priv.h>
79 STATIC_ASSERT (VLIB_BUFFER_PRE_DATA_SIZE == RTE_PKTMBUF_HEADROOM,
80 "VLIB_BUFFER_PRE_DATA_SIZE must be equal to RTE_PKTMBUF_HEADROOM");
82 #define BUFFERS_PER_COPY (sizeof (vlib_copy_unit_t) / sizeof (u32))
84 /* Make sure we have at least given number of unaligned buffers. */
86 fill_unaligned (vlib_main_t * vm,
87 vlib_buffer_free_list_t * free_list,
88 uword n_unaligned_buffers)
90 word la = vec_len (free_list->aligned_buffers);
91 word lu = vec_len (free_list->unaligned_buffers);
93 /* Aligned come in aligned copy-sized chunks. */
94 ASSERT (la % BUFFERS_PER_COPY == 0);
96 ASSERT (la >= n_unaligned_buffers);
98 while (lu < n_unaligned_buffers)
100 /* Copy 4 buffers from end of aligned vector to unaligned vector. */
101 vec_add (free_list->unaligned_buffers,
102 free_list->aligned_buffers + la - BUFFERS_PER_COPY,
104 la -= BUFFERS_PER_COPY;
105 lu += BUFFERS_PER_COPY;
107 _vec_len (free_list->aligned_buffers) = la;
110 /* After free aligned buffers may not contain even sized chunks. */
112 trim_aligned (vlib_buffer_free_list_t * f)
116 /* Add unaligned to aligned before trim. */
117 l = vec_len (f->unaligned_buffers);
120 vec_add_aligned (f->aligned_buffers, f->unaligned_buffers, l,
121 /* align */ sizeof (vlib_copy_unit_t));
123 _vec_len (f->unaligned_buffers) = 0;
126 /* Remove unaligned buffers from end of aligned vector and save for next trim. */
127 l = vec_len (f->aligned_buffers);
128 n_trim = l % BUFFERS_PER_COPY;
131 /* Trim aligned -> unaligned. */
132 vec_add (f->unaligned_buffers, f->aligned_buffers + l - n_trim, n_trim);
134 /* Remove from aligned. */
135 _vec_len (f->aligned_buffers) = l - n_trim;
140 merge_free_lists (vlib_buffer_free_list_t * dst,
141 vlib_buffer_free_list_t * src)
149 l = vec_len (src->aligned_buffers);
152 vec_add2_aligned (dst->aligned_buffers, d, l,
153 /* align */ sizeof (vlib_copy_unit_t));
154 clib_memcpy (d, src->aligned_buffers, l * sizeof (d[0]));
155 vec_free (src->aligned_buffers);
158 l = vec_len (src->unaligned_buffers);
161 vec_add (dst->unaligned_buffers, src->unaligned_buffers, l);
162 vec_free (src->unaligned_buffers);
167 dpdk_buffer_get_free_list_with_size (vlib_main_t * vm, u32 size)
169 vlib_buffer_main_t *bm = vm->buffer_main;
171 size = vlib_buffer_round_size (size);
172 uword *p = hash_get (bm->free_list_by_size, size);
173 return p ? p[0] : ~0;
177 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
183 for (i = 0; i < vec_len (f->unaligned_buffers); i++)
185 b = vlib_get_buffer (vm, f->unaligned_buffers[i]);
186 mb = rte_mbuf_from_vlib_buffer (b);
187 ASSERT (rte_mbuf_refcnt_read (mb) == 1);
188 rte_pktmbuf_free (mb);
190 for (i = 0; i < vec_len (f->aligned_buffers); i++)
192 b = vlib_get_buffer (vm, f->aligned_buffers[i]);
193 mb = rte_mbuf_from_vlib_buffer (b);
194 ASSERT (rte_mbuf_refcnt_read (mb) == 1);
195 rte_pktmbuf_free (mb);
198 vec_free (f->unaligned_buffers);
199 vec_free (f->aligned_buffers);
202 /* Add buffer free list. */
204 dpdk_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index)
206 vlib_buffer_main_t *bm = vm->buffer_main;
207 vlib_buffer_free_list_t *f;
211 ASSERT (os_get_cpu_number () == 0);
213 f = vlib_buffer_get_free_list (vm, free_list_index);
215 merge_index = dpdk_buffer_get_free_list_with_size (vm, f->n_data_bytes);
216 if (merge_index != ~0 && merge_index != free_list_index)
218 merge_free_lists (pool_elt_at_index (bm->buffer_free_list_pool,
222 del_free_list (vm, f);
225 memset (f, 0xab, sizeof (f[0]));
227 pool_put (bm->buffer_free_list_pool, f);
229 for (i = 1; i < vec_len (vlib_mains); i++)
231 bm = vlib_mains[i]->buffer_main;
232 f = vlib_buffer_get_free_list (vlib_mains[i], free_list_index);;
233 memset (f, 0xab, sizeof (f[0]));
234 pool_put (bm->buffer_free_list_pool, f);
238 /* Make sure free list has at least given number of free buffers. */
240 fill_free_list (vlib_main_t * vm,
241 vlib_buffer_free_list_t * fl, uword min_free_buffers)
243 dpdk_main_t *dm = &dpdk_main;
247 u32 n_remaining = 0, n_alloc = 0;
248 unsigned socket_id = rte_socket_id ();
249 struct rte_mempool *rmp = dm->pktmbuf_pools[socket_id];
253 if (PREDICT_FALSE (rmp == 0))
258 /* Already have enough free buffers on free list? */
259 n = min_free_buffers - vec_len (fl->aligned_buffers);
261 return min_free_buffers;
263 /* Always allocate round number of buffers. */
264 n = round_pow2 (n, BUFFERS_PER_COPY);
266 /* Always allocate new buffers in reasonably large sized chunks. */
267 n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
269 vec_validate (vm->mbuf_alloc_list, n - 1);
271 if (rte_mempool_get_bulk (rmp, vm->mbuf_alloc_list, n) < 0)
274 _vec_len (vm->mbuf_alloc_list) = n;
276 for (i = 0; i < n; i++)
278 mb = vm->mbuf_alloc_list[i];
280 ASSERT (rte_mbuf_refcnt_read (mb) == 0);
281 rte_mbuf_refcnt_set (mb, 1);
283 b = vlib_buffer_from_rte_mbuf (mb);
284 bi = vlib_get_buffer_index (vm, b);
286 vec_add1_aligned (fl->aligned_buffers, bi, sizeof (vlib_copy_unit_t));
290 vlib_buffer_init_for_free_list (b, fl);
292 if (fl->buffer_init_function)
293 fl->buffer_init_function (vm, fl, &bi, 1);
302 copy_alignment (u32 * x)
304 return (pointer_to_uword (x) / sizeof (x[0])) % BUFFERS_PER_COPY;
308 alloc_from_free_list (vlib_main_t * vm,
309 vlib_buffer_free_list_t * free_list,
310 u32 * alloc_buffers, u32 n_alloc_buffers)
314 uword n_unaligned_start, n_unaligned_end, n_filled;
316 n_left = n_alloc_buffers;
318 n_unaligned_start = ((BUFFERS_PER_COPY - copy_alignment (dst))
319 & (BUFFERS_PER_COPY - 1));
321 n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
325 n_left = n_filled < n_left ? n_filled : n_left;
326 n_alloc_buffers = n_left;
328 if (n_unaligned_start >= n_left)
330 n_unaligned_start = n_left;
334 n_unaligned_end = copy_alignment (dst + n_alloc_buffers);
336 fill_unaligned (vm, free_list, n_unaligned_start + n_unaligned_end);
338 u_len = vec_len (free_list->unaligned_buffers);
339 u_src = free_list->unaligned_buffers + u_len - 1;
341 if (n_unaligned_start)
343 uword n_copy = n_unaligned_start;
355 /* Now dst should be aligned. */
357 ASSERT (pointer_to_uword (dst) % sizeof (vlib_copy_unit_t) == 0);
362 vlib_copy_unit_t *d, *s;
365 if (vec_len (free_list->aligned_buffers) <
366 ((n_left / BUFFERS_PER_COPY) * BUFFERS_PER_COPY))
369 n_copy = n_left / BUFFERS_PER_COPY;
370 n_left = n_left % BUFFERS_PER_COPY;
372 /* Remove buffers from aligned free list. */
373 _vec_len (free_list->aligned_buffers) -= n_copy * BUFFERS_PER_COPY;
375 s = (vlib_copy_unit_t *) vec_end (free_list->aligned_buffers);
376 d = (vlib_copy_unit_t *) dst;
378 /* Fast path loop. */
401 /* Unaligned copy. */
402 ASSERT (n_unaligned_end == n_left);
410 if (!free_list->unaligned_buffers)
413 _vec_len (free_list->unaligned_buffers) = u_len;
415 return n_alloc_buffers;
418 /* Allocate a given number of buffers into given array.
419 Returns number actually allocated which will be either zero or
422 dpdk_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
424 vlib_buffer_main_t *bm = vm->buffer_main;
426 return alloc_from_free_list
428 pool_elt_at_index (bm->buffer_free_list_pool,
429 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
435 dpdk_buffer_alloc_from_free_list (vlib_main_t * vm,
437 u32 n_buffers, u32 free_list_index)
439 vlib_buffer_main_t *bm = vm->buffer_main;
440 vlib_buffer_free_list_t *f;
441 f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
442 return alloc_from_free_list (vm, f, buffers, n_buffers);
446 add_buffer_to_free_list (vlib_main_t * vm,
447 vlib_buffer_free_list_t * f,
448 u32 buffer_index, u8 do_init)
451 b = vlib_get_buffer (vm, buffer_index);
452 if (PREDICT_TRUE (do_init))
453 vlib_buffer_init_for_free_list (b, f);
454 vec_add1_aligned (f->aligned_buffers, buffer_index,
455 sizeof (vlib_copy_unit_t));
458 always_inline vlib_buffer_free_list_t *
459 buffer_get_free_list (vlib_main_t * vm, vlib_buffer_t * b, u32 * index)
461 vlib_buffer_main_t *bm = vm->buffer_main;
464 *index = i = b->free_list_index;
465 return pool_elt_at_index (bm->buffer_free_list_pool, i);
468 static_always_inline void
469 vlib_buffer_free_inline (vlib_main_t * vm,
470 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
472 vlib_buffer_main_t *bm = vm->buffer_main;
473 vlib_buffer_free_list_t *fl;
476 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
477 u32 follow_buffer_next);
479 cb = bm->buffer_free_callback;
481 if (PREDICT_FALSE (cb != 0))
482 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
487 for (i = 0; i < n_buffers; i++)
492 b = vlib_get_buffer (vm, buffers[i]);
494 fl = buffer_get_free_list (vm, b, &fi);
496 /* The only current use of this callback: multicast recycle */
497 if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
501 add_buffer_to_free_list
502 (vm, fl, buffers[i], (b->flags & VLIB_BUFFER_RECYCLE) == 0);
504 for (j = 0; j < vec_len (bm->announce_list); j++)
506 if (fl == bm->announce_list[j])
507 goto already_announced;
509 vec_add1 (bm->announce_list, fl);
515 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0))
517 mb = rte_mbuf_from_vlib_buffer (b);
518 ASSERT (rte_mbuf_refcnt_read (mb) == 1);
519 rte_pktmbuf_free (mb);
523 if (vec_len (bm->announce_list))
525 vlib_buffer_free_list_t *fl;
526 for (i = 0; i < vec_len (bm->announce_list); i++)
528 fl = bm->announce_list[i];
529 fl->buffers_added_to_freelist_function (vm, fl);
531 _vec_len (bm->announce_list) = 0;
536 dpdk_buffer_free (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
538 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
543 dpdk_buffer_free_no_next (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
545 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
550 dpdk_packet_template_init (vlib_main_t * vm,
553 uword n_packet_data_bytes,
554 uword min_n_buffers_each_physmem_alloc, u8 * name)
556 vlib_packet_template_t *t = (vlib_packet_template_t *) vt;
558 vlib_worker_thread_barrier_sync (vm);
559 memset (t, 0, sizeof (t[0]));
561 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
563 vlib_worker_thread_barrier_release (vm);
567 vlib_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
570 dpdk_main_t *dm = &dpdk_main;
571 vlib_physmem_main_t *vpm = &vm->physmem_main;
572 struct rte_mempool *rmp;
575 vec_validate_aligned (dm->pktmbuf_pools, socket_id, CLIB_CACHE_LINE_BYTES);
577 /* pool already exists, nothing to do */
578 if (dm->pktmbuf_pools[socket_id])
581 u8 *pool_name = format (0, "mbuf_pool_socket%u%c", socket_id, 0);
583 rmp = rte_pktmbuf_pool_create ((char *) pool_name, /* pool name */
584 num_mbufs, /* number of mbufs */
585 512, /* cache size */
586 VLIB_BUFFER_HDR_SIZE, /* priv size */
587 VLIB_BUFFER_PRE_DATA_SIZE + VLIB_BUFFER_DATA_SIZE, /* dataroom size */
588 socket_id); /* cpu socket */
594 uword this_pool_start;
595 uword this_pool_size;
596 uword save_vpm_start, save_vpm_end, save_vpm_size;
597 struct rte_mempool_memhdr *memhdr;
599 this_pool_start = ~0ULL;
602 STAILQ_FOREACH (memhdr, &rmp->mem_list, next)
604 if (((uword) (memhdr->addr + memhdr->len)) > this_pool_end)
605 this_pool_end = (uword) (memhdr->addr + memhdr->len);
606 if (((uword) memhdr->addr) < this_pool_start)
607 this_pool_start = (uword) (memhdr->addr);
609 ASSERT (this_pool_start < ~0ULL && this_pool_end > 0);
610 this_pool_size = this_pool_end - this_pool_start;
614 clib_warning ("%s: pool start %llx pool end %llx pool size %lld",
615 pool_name, this_pool_start, this_pool_end,
618 ("before: virtual.start %llx virtual.end %llx virtual.size %lld",
619 vpm->virtual.start, vpm->virtual.end, vpm->virtual.size);
622 save_vpm_start = vpm->virtual.start;
623 save_vpm_end = vpm->virtual.end;
624 save_vpm_size = vpm->virtual.size;
626 if ((this_pool_start < vpm->virtual.start) || vpm->virtual.start == 0)
627 vpm->virtual.start = this_pool_start;
628 if (this_pool_end > vpm->virtual.end)
629 vpm->virtual.end = this_pool_end;
631 vpm->virtual.size = vpm->virtual.end - vpm->virtual.start;
636 ("after: virtual.start %llx virtual.end %llx virtual.size %lld",
637 vpm->virtual.start, vpm->virtual.end, vpm->virtual.size);
640 /* check if fits into buffer index range */
641 if ((u64) vpm->virtual.size >
642 ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
644 clib_warning ("physmem: virtual size out of range!");
645 vpm->virtual.start = save_vpm_start;
646 vpm->virtual.end = save_vpm_end;
647 vpm->virtual.size = save_vpm_size;
653 dm->pktmbuf_pools[socket_id] = rmp;
654 vec_free (pool_name);
659 vec_free (pool_name);
661 /* no usable pool for this socket, try to use pool from another one */
662 for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
664 if (dm->pktmbuf_pools[i])
667 ("WARNING: Failed to allocate mempool for CPU socket %u. "
668 "Threads running on socket %u will use socket %u mempool.",
669 socket_id, socket_id, i);
670 dm->pktmbuf_pools[socket_id] = dm->pktmbuf_pools[i];
675 return clib_error_return (0, "failed to allocate mempool on socket %u",
681 u32 *vlib_buffer_state_validation_lock;
682 uword *vlib_buffer_state_validation_hash;
683 void *vlib_buffer_state_heap;
685 static clib_error_t *
686 buffer_state_validation_init (vlib_main_t * vm)
690 vlib_buffer_state_heap = mheap_alloc (0, 10 << 20);
692 oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
694 vlib_buffer_state_validation_hash = hash_create (0, sizeof (uword));
695 vec_validate_aligned (vlib_buffer_state_validation_lock, 0,
696 CLIB_CACHE_LINE_BYTES);
697 clib_mem_set_heap (oldheap);
701 VLIB_INIT_FUNCTION (buffer_state_validation_init);
704 static vlib_buffer_callbacks_t callbacks = {
705 .vlib_buffer_alloc_cb = &dpdk_buffer_alloc,
706 .vlib_buffer_alloc_from_free_list_cb = &dpdk_buffer_alloc_from_free_list,
707 .vlib_buffer_free_cb = &dpdk_buffer_free,
708 .vlib_buffer_free_no_next_cb = &dpdk_buffer_free_no_next,
709 .vlib_packet_template_init_cb = &dpdk_packet_template_init,
710 .vlib_buffer_delete_free_list_cb = &dpdk_buffer_delete_free_list,
713 static clib_error_t *
714 dpdk_buffer_init (vlib_main_t * vm)
716 vlib_buffer_cb_register (vm, &callbacks);
720 VLIB_INIT_FUNCTION (dpdk_buffer_init);
724 * fd.io coding-style-patch-verification: ON
727 * eval: (c-set-style "gnu")