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))
85 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
91 for (i = 0; i < vec_len (f->unaligned_buffers); i++)
93 b = vlib_get_buffer (vm, f->unaligned_buffers[i]);
94 mb = rte_mbuf_from_vlib_buffer (b);
95 ASSERT (rte_mbuf_refcnt_read (mb) == 1);
96 rte_pktmbuf_free (mb);
98 for (i = 0; i < vec_len (f->aligned_buffers); i++)
100 b = vlib_get_buffer (vm, f->aligned_buffers[i]);
101 mb = rte_mbuf_from_vlib_buffer (b);
102 ASSERT (rte_mbuf_refcnt_read (mb) == 1);
103 rte_pktmbuf_free (mb);
106 vec_free (f->unaligned_buffers);
107 vec_free (f->aligned_buffers);
110 /* Add buffer free list. */
112 dpdk_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index)
114 vlib_buffer_main_t *bm = vm->buffer_main;
115 vlib_buffer_free_list_t *f;
119 ASSERT (os_get_cpu_number () == 0);
121 f = vlib_buffer_get_free_list (vm, free_list_index);
123 merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
124 if (merge_index != ~0 && merge_index != free_list_index)
126 vlib_buffer_merge_free_lists (pool_elt_at_index
127 (bm->buffer_free_list_pool, merge_index),
131 del_free_list (vm, f);
134 memset (f, 0xab, sizeof (f[0]));
136 pool_put (bm->buffer_free_list_pool, f);
138 for (i = 1; i < vec_len (vlib_mains); i++)
140 bm = vlib_mains[i]->buffer_main;
141 f = vlib_buffer_get_free_list (vlib_mains[i], free_list_index);;
142 memset (f, 0xab, sizeof (f[0]));
143 pool_put (bm->buffer_free_list_pool, f);
147 /* Make sure free list has at least given number of free buffers. */
149 fill_free_list (vlib_main_t * vm,
150 vlib_buffer_free_list_t * fl, uword min_free_buffers)
152 dpdk_main_t *dm = &dpdk_main;
156 u32 n_remaining = 0, n_alloc = 0;
157 unsigned socket_id = rte_socket_id ();
158 struct rte_mempool *rmp = dm->pktmbuf_pools[socket_id];
162 if (PREDICT_FALSE (rmp == 0))
165 vlib_buffer_free_list_trim_aligned (fl);
167 /* Already have enough free buffers on free list? */
168 n = min_free_buffers - vec_len (fl->aligned_buffers);
170 return min_free_buffers;
172 /* Always allocate round number of buffers. */
173 n = round_pow2 (n, BUFFERS_PER_COPY);
175 /* Always allocate new buffers in reasonably large sized chunks. */
176 n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
178 vec_validate (vm->mbuf_alloc_list, n - 1);
180 if (rte_mempool_get_bulk (rmp, vm->mbuf_alloc_list, n) < 0)
183 _vec_len (vm->mbuf_alloc_list) = n;
185 for (i = 0; i < n; i++)
187 mb = vm->mbuf_alloc_list[i];
189 ASSERT (rte_mbuf_refcnt_read (mb) == 0);
190 rte_mbuf_refcnt_set (mb, 1);
192 b = vlib_buffer_from_rte_mbuf (mb);
193 bi = vlib_get_buffer_index (vm, b);
195 vec_add1_aligned (fl->aligned_buffers, bi, sizeof (vlib_copy_unit_t));
199 vlib_buffer_init_for_free_list (b, fl);
201 if (fl->buffer_init_function)
202 fl->buffer_init_function (vm, fl, &bi, 1);
211 copy_alignment (u32 * x)
213 return (pointer_to_uword (x) / sizeof (x[0])) % BUFFERS_PER_COPY;
217 alloc_from_free_list (vlib_main_t * vm,
218 vlib_buffer_free_list_t * free_list,
219 u32 * alloc_buffers, u32 n_alloc_buffers)
223 uword n_unaligned_start, n_unaligned_end, n_filled;
225 n_left = n_alloc_buffers;
227 n_unaligned_start = ((BUFFERS_PER_COPY - copy_alignment (dst))
228 & (BUFFERS_PER_COPY - 1));
230 n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
234 n_left = n_filled < n_left ? n_filled : n_left;
235 n_alloc_buffers = n_left;
237 if (n_unaligned_start >= n_left)
239 n_unaligned_start = n_left;
243 n_unaligned_end = copy_alignment (dst + n_alloc_buffers);
245 vlib_buffer_free_list_fill_unaligned (vm, free_list,
246 n_unaligned_start + n_unaligned_end);
248 u_len = vec_len (free_list->unaligned_buffers);
249 u_src = free_list->unaligned_buffers + u_len - 1;
251 if (n_unaligned_start)
253 uword n_copy = n_unaligned_start;
265 /* Now dst should be aligned. */
267 ASSERT (pointer_to_uword (dst) % sizeof (vlib_copy_unit_t) == 0);
272 vlib_copy_unit_t *d, *s;
275 if (vec_len (free_list->aligned_buffers) <
276 ((n_left / BUFFERS_PER_COPY) * BUFFERS_PER_COPY))
279 n_copy = n_left / BUFFERS_PER_COPY;
280 n_left = n_left % BUFFERS_PER_COPY;
282 /* Remove buffers from aligned free list. */
283 _vec_len (free_list->aligned_buffers) -= n_copy * BUFFERS_PER_COPY;
285 s = (vlib_copy_unit_t *) vec_end (free_list->aligned_buffers);
286 d = (vlib_copy_unit_t *) dst;
288 /* Fast path loop. */
311 /* Unaligned copy. */
312 ASSERT (n_unaligned_end == n_left);
320 if (!free_list->unaligned_buffers)
323 _vec_len (free_list->unaligned_buffers) = u_len;
325 return n_alloc_buffers;
328 /* Allocate a given number of buffers into given array.
329 Returns number actually allocated which will be either zero or
332 dpdk_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
334 vlib_buffer_main_t *bm = vm->buffer_main;
336 return alloc_from_free_list
338 pool_elt_at_index (bm->buffer_free_list_pool,
339 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
345 dpdk_buffer_alloc_from_free_list (vlib_main_t * vm,
347 u32 n_buffers, u32 free_list_index)
349 vlib_buffer_main_t *bm = vm->buffer_main;
350 vlib_buffer_free_list_t *f;
351 f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
352 return alloc_from_free_list (vm, f, buffers, n_buffers);
355 static_always_inline void
356 vlib_buffer_free_inline (vlib_main_t * vm,
357 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
359 vlib_buffer_main_t *bm = vm->buffer_main;
360 vlib_buffer_free_list_t *fl;
363 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
364 u32 follow_buffer_next);
366 cb = bm->buffer_free_callback;
368 if (PREDICT_FALSE (cb != 0))
369 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
374 for (i = 0; i < n_buffers; i++)
379 b = vlib_get_buffer (vm, buffers[i]);
381 fl = vlib_buffer_get_buffer_free_list (vm, b, &fi);
383 /* The only current use of this callback: multicast recycle */
384 if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
388 vlib_buffer_add_to_free_list
389 (vm, fl, buffers[i], (b->flags & VLIB_BUFFER_RECYCLE) == 0);
391 for (j = 0; j < vec_len (bm->announce_list); j++)
393 if (fl == bm->announce_list[j])
394 goto already_announced;
396 vec_add1 (bm->announce_list, fl);
402 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0))
404 mb = rte_mbuf_from_vlib_buffer (b);
405 ASSERT (rte_mbuf_refcnt_read (mb) == 1);
406 rte_pktmbuf_free (mb);
410 if (vec_len (bm->announce_list))
412 vlib_buffer_free_list_t *fl;
413 for (i = 0; i < vec_len (bm->announce_list); i++)
415 fl = bm->announce_list[i];
416 fl->buffers_added_to_freelist_function (vm, fl);
418 _vec_len (bm->announce_list) = 0;
423 dpdk_buffer_free (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
425 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
430 dpdk_buffer_free_no_next (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
432 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
437 dpdk_packet_template_init (vlib_main_t * vm,
440 uword n_packet_data_bytes,
441 uword min_n_buffers_each_physmem_alloc, u8 * name)
443 vlib_packet_template_t *t = (vlib_packet_template_t *) vt;
445 vlib_worker_thread_barrier_sync (vm);
446 memset (t, 0, sizeof (t[0]));
448 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
450 vlib_worker_thread_barrier_release (vm);
454 vlib_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
457 dpdk_main_t *dm = &dpdk_main;
458 vlib_physmem_main_t *vpm = &vm->physmem_main;
459 struct rte_mempool *rmp;
462 vec_validate_aligned (dm->pktmbuf_pools, socket_id, CLIB_CACHE_LINE_BYTES);
464 /* pool already exists, nothing to do */
465 if (dm->pktmbuf_pools[socket_id])
468 u8 *pool_name = format (0, "mbuf_pool_socket%u%c", socket_id, 0);
470 rmp = rte_pktmbuf_pool_create ((char *) pool_name, /* pool name */
471 num_mbufs, /* number of mbufs */
472 512, /* cache size */
473 VLIB_BUFFER_HDR_SIZE, /* priv size */
474 VLIB_BUFFER_PRE_DATA_SIZE + VLIB_BUFFER_DATA_SIZE, /* dataroom size */
475 socket_id); /* cpu socket */
481 uword this_pool_start;
482 uword this_pool_size;
483 uword save_vpm_start, save_vpm_end, save_vpm_size;
484 struct rte_mempool_memhdr *memhdr;
486 this_pool_start = ~0ULL;
489 STAILQ_FOREACH (memhdr, &rmp->mem_list, next)
491 if (((uword) (memhdr->addr + memhdr->len)) > this_pool_end)
492 this_pool_end = (uword) (memhdr->addr + memhdr->len);
493 if (((uword) memhdr->addr) < this_pool_start)
494 this_pool_start = (uword) (memhdr->addr);
496 ASSERT (this_pool_start < ~0ULL && this_pool_end > 0);
497 this_pool_size = this_pool_end - this_pool_start;
501 clib_warning ("%s: pool start %llx pool end %llx pool size %lld",
502 pool_name, this_pool_start, this_pool_end,
505 ("before: virtual.start %llx virtual.end %llx virtual.size %lld",
506 vpm->virtual.start, vpm->virtual.end, vpm->virtual.size);
509 save_vpm_start = vpm->virtual.start;
510 save_vpm_end = vpm->virtual.end;
511 save_vpm_size = vpm->virtual.size;
513 if ((this_pool_start < vpm->virtual.start) || vpm->virtual.start == 0)
514 vpm->virtual.start = this_pool_start;
515 if (this_pool_end > vpm->virtual.end)
516 vpm->virtual.end = this_pool_end;
518 vpm->virtual.size = vpm->virtual.end - vpm->virtual.start;
523 ("after: virtual.start %llx virtual.end %llx virtual.size %lld",
524 vpm->virtual.start, vpm->virtual.end, vpm->virtual.size);
527 /* check if fits into buffer index range */
528 if ((u64) vpm->virtual.size >
529 ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
531 clib_warning ("physmem: virtual size out of range!");
532 vpm->virtual.start = save_vpm_start;
533 vpm->virtual.end = save_vpm_end;
534 vpm->virtual.size = save_vpm_size;
540 dm->pktmbuf_pools[socket_id] = rmp;
541 vec_free (pool_name);
546 vec_free (pool_name);
548 /* no usable pool for this socket, try to use pool from another one */
549 for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
551 if (dm->pktmbuf_pools[i])
554 ("WARNING: Failed to allocate mempool for CPU socket %u. "
555 "Threads running on socket %u will use socket %u mempool.",
556 socket_id, socket_id, i);
557 dm->pktmbuf_pools[socket_id] = dm->pktmbuf_pools[i];
562 return clib_error_return (0, "failed to allocate mempool on socket %u",
568 u32 *vlib_buffer_state_validation_lock;
569 uword *vlib_buffer_state_validation_hash;
570 void *vlib_buffer_state_heap;
572 static clib_error_t *
573 buffer_state_validation_init (vlib_main_t * vm)
577 vlib_buffer_state_heap = mheap_alloc (0, 10 << 20);
579 oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
581 vlib_buffer_state_validation_hash = hash_create (0, sizeof (uword));
582 vec_validate_aligned (vlib_buffer_state_validation_lock, 0,
583 CLIB_CACHE_LINE_BYTES);
584 clib_mem_set_heap (oldheap);
588 VLIB_INIT_FUNCTION (buffer_state_validation_init);
591 static vlib_buffer_callbacks_t callbacks = {
592 .vlib_buffer_alloc_cb = &dpdk_buffer_alloc,
593 .vlib_buffer_alloc_from_free_list_cb = &dpdk_buffer_alloc_from_free_list,
594 .vlib_buffer_free_cb = &dpdk_buffer_free,
595 .vlib_buffer_free_no_next_cb = &dpdk_buffer_free_no_next,
596 .vlib_packet_template_init_cb = &dpdk_packet_template_init,
597 .vlib_buffer_delete_free_list_cb = &dpdk_buffer_delete_free_list,
600 static clib_error_t *
601 dpdk_buffer_init (vlib_main_t * vm)
603 vlib_buffer_cb_register (vm, &callbacks);
607 VLIB_INIT_FUNCTION (dpdk_buffer_init);
611 * fd.io coding-style-patch-verification: ON
614 * eval: (c-set-style "gnu")