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.
48 #include <rte_config.h>
50 #include <rte_common.h>
52 #include <rte_memory.h>
53 #include <rte_memzone.h>
54 #include <rte_tailq.h>
56 #include <rte_per_lcore.h>
57 #include <rte_launch.h>
58 #include <rte_atomic.h>
59 #include <rte_cycles.h>
60 #include <rte_prefetch.h>
61 #include <rte_lcore.h>
62 #include <rte_per_lcore.h>
63 #include <rte_branch_prediction.h>
64 #include <rte_interrupts.h>
66 #include <rte_random.h>
67 #include <rte_debug.h>
68 #include <rte_ether.h>
69 #include <rte_ethdev.h>
71 #include <rte_mempool.h>
73 #include <rte_version.h>
75 #include <vlib/vlib.h>
76 #include <vlib/unix/unix.h>
77 #include <vnet/vnet.h>
78 #include <dpdk/device/dpdk.h>
79 #include <dpdk/device/dpdk_priv.h>
80 #include <dpdk/buffer.h>
82 STATIC_ASSERT (VLIB_BUFFER_PRE_DATA_SIZE == RTE_PKTMBUF_HEADROOM,
83 "VLIB_BUFFER_PRE_DATA_SIZE must be equal to RTE_PKTMBUF_HEADROOM");
87 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
88 struct rte_mbuf **mbuf_alloc_list;
89 } dpdk_buffer_per_thread_data;
93 int vfio_container_fd;
94 dpdk_buffer_per_thread_data *ptd;
97 dpdk_buffer_main_t dpdk_buffer_main;
99 static_always_inline void
100 dpdk_rte_pktmbuf_free (vlib_main_t * vm, u32 thread_index, vlib_buffer_t * b,
108 next = b->next_buffer;
109 mb = rte_mbuf_from_vlib_buffer (b);
111 if (PREDICT_FALSE (b->n_add_refs))
113 rte_mbuf_refcnt_update (mb, b->n_add_refs);
117 if ((mb = rte_pktmbuf_prefree_seg (mb)))
118 rte_mempool_put (mb->pool, mb);
120 if (maybe_next && (flags & VLIB_BUFFER_NEXT_PRESENT))
122 b = vlib_get_buffer (vm, next);
127 /* Make sure free list has at least given number of free buffers. */
129 CLIB_MULTIARCH_FN (dpdk_buffer_fill_free_list) (vlib_main_t * vm,
130 vlib_buffer_free_list_t * fl,
131 uword min_free_buffers)
133 dpdk_main_t *dm = &dpdk_main;
134 dpdk_buffer_main_t *dbm = &dpdk_buffer_main;
135 struct rte_mbuf **mb;
138 unsigned socket_id = rte_socket_id ();
139 u32 thread_index = vlib_get_thread_index ();
140 dpdk_buffer_per_thread_data *d = vec_elt_at_index (dbm->ptd, thread_index);
141 struct rte_mempool *rmp = dm->pktmbuf_pools[socket_id];
142 dpdk_mempool_private_t *privp = rte_mempool_get_priv (rmp);
147 if (PREDICT_FALSE (rmp == 0))
150 /* Already have enough free buffers on free list? */
151 n_alloc = min_free_buffers - vec_len (fl->buffers);
153 return min_free_buffers;
155 /* Always allocate round number of buffers. */
156 n_alloc = round_pow2 (n_alloc, CLIB_CACHE_LINE_BYTES / sizeof (u32));
158 /* Always allocate new buffers in reasonably large sized chunks. */
159 n_alloc = clib_max (n_alloc, fl->min_n_buffers_each_alloc);
161 vec_validate_aligned (d->mbuf_alloc_list, n_alloc - 1,
162 CLIB_CACHE_LINE_BYTES);
164 if (rte_mempool_get_bulk (rmp, (void *) d->mbuf_alloc_list, n_alloc) < 0)
167 clib_memset (&bt, 0, sizeof (vlib_buffer_t));
168 bt.buffer_pool_index = privp->buffer_pool_index;
170 _vec_len (d->mbuf_alloc_list) = n_alloc;
172 first = vec_len (fl->buffers);
173 vec_resize_aligned (fl->buffers, n_alloc, CLIB_CACHE_LINE_BYTES);
176 mb = d->mbuf_alloc_list;
177 bi = fl->buffers + first;
179 ASSERT (n_left % 8 == 0);
183 if (PREDICT_FALSE (n_left < 24))
186 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[16]), STORE);
187 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[17]), STORE);
188 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[18]), STORE);
189 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[19]), STORE);
190 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[20]), STORE);
191 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[21]), STORE);
192 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[22]), STORE);
193 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[23]), STORE);
196 vlib_get_buffer_indices_with_offset (vm, (void **) mb, bi, 8,
197 sizeof (struct rte_mbuf));
199 vlib_buffer_copy_template (vlib_buffer_from_rte_mbuf (mb[0]), &bt);
200 vlib_buffer_copy_template (vlib_buffer_from_rte_mbuf (mb[1]), &bt);
201 vlib_buffer_copy_template (vlib_buffer_from_rte_mbuf (mb[2]), &bt);
202 vlib_buffer_copy_template (vlib_buffer_from_rte_mbuf (mb[3]), &bt);
203 vlib_buffer_copy_template (vlib_buffer_from_rte_mbuf (mb[4]), &bt);
204 vlib_buffer_copy_template (vlib_buffer_from_rte_mbuf (mb[5]), &bt);
205 vlib_buffer_copy_template (vlib_buffer_from_rte_mbuf (mb[6]), &bt);
206 vlib_buffer_copy_template (vlib_buffer_from_rte_mbuf (mb[7]), &bt);
213 if (fl->buffer_init_function)
214 fl->buffer_init_function (vm, fl, fl->buffers + first, n_alloc);
216 fl->n_alloc += n_alloc;
221 static_always_inline void
222 dpdk_prefetch_buffer (vlib_buffer_t * b)
225 mb = rte_mbuf_from_vlib_buffer (b);
226 CLIB_PREFETCH (mb, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
227 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, LOAD);
230 static_always_inline void
231 recycle_or_free (vlib_main_t * vm, vlib_buffer_main_t * bm, u32 bi,
234 u32 thread_index = vlib_get_thread_index ();
236 dpdk_rte_pktmbuf_free (vm, thread_index, b, 1);
239 static_always_inline void
240 vlib_buffer_free_inline (vlib_main_t * vm,
241 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
243 vlib_buffer_main_t *bm = vm->buffer_main;
244 vlib_buffer_t *bufp[n_buffers], **b = bufp;
245 u32 thread_index = vm->thread_index;
247 u32 simple_mask = VLIB_BUFFER_NEXT_PRESENT;
249 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
250 u32 follow_buffer_next);
252 cb = bm->buffer_free_callback;
254 if (PREDICT_FALSE (cb != 0))
255 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
263 vlib_get_buffers (vm, bi, b, n_buffers);
274 dpdk_prefetch_buffer (p[0]);
275 dpdk_prefetch_buffer (p[1]);
276 dpdk_prefetch_buffer (p[2]);
277 dpdk_prefetch_buffer (p[3]);
280 for (i = 0; i < 4; i++)
281 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[i]);
283 or_flags = b[0]->flags | b[1]->flags | b[2]->flags | b[3]->flags;
285 if (or_flags & simple_mask)
287 recycle_or_free (vm, bm, bi[0], b[0]);
288 recycle_or_free (vm, bm, bi[1], b[1]);
289 recycle_or_free (vm, bm, bi[2], b[2]);
290 recycle_or_free (vm, bm, bi[3], b[3]);
294 dpdk_rte_pktmbuf_free (vm, thread_index, b[0], 0);
295 dpdk_rte_pktmbuf_free (vm, thread_index, b[1], 0);
296 dpdk_rte_pktmbuf_free (vm, thread_index, b[2], 0);
297 dpdk_rte_pktmbuf_free (vm, thread_index, b[3], 0);
305 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
306 recycle_or_free (vm, bm, bi[0], b[0]);
314 CLIB_MULTIARCH_FN (dpdk_buffer_free) (vlib_main_t * vm, u32 * buffers,
317 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
322 CLIB_MULTIARCH_FN (dpdk_buffer_free_no_next) (vlib_main_t * vm, u32 * buffers,
325 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
329 #ifndef CLIB_MARCH_VARIANT
331 dpdk_pool_create (vlib_main_t * vm, u8 * pool_name, u32 elt_size,
332 u32 num_elts, u32 pool_priv_size, u16 cache_size, u8 numa,
333 struct rte_mempool **_mp, u32 * map_index)
335 struct rte_mempool *mp;
336 enum rte_iova_mode iova_mode;
337 dpdk_mempool_private_t priv;
338 vlib_physmem_map_t *pm;
339 clib_error_t *error = 0;
340 size_t min_chunk_size, align;
346 mp = rte_mempool_create_empty ((char *) pool_name, num_elts, elt_size,
347 512, pool_priv_size, numa, 0);
349 return clib_error_return (0, "failed to create %s", pool_name);
351 rte_mempool_set_ops_byname (mp, RTE_MBUF_DEFAULT_MEMPOOL_OPS, NULL);
353 size = rte_mempool_op_calc_mem_size_default (mp, num_elts, 21,
354 &min_chunk_size, &align);
356 if ((error = vlib_physmem_shared_map_create (vm, (char *) pool_name, size,
357 0, numa, map_index)))
359 rte_mempool_free (mp);
362 pm = vlib_physmem_get_map (vm, *map_index);
364 /* Call the mempool priv initializer */
365 priv.mbp_priv.mbuf_data_room_size = VLIB_BUFFER_PRE_DATA_SIZE +
366 VLIB_BUFFER_DATA_SIZE;
367 priv.mbp_priv.mbuf_priv_size = VLIB_BUFFER_HDR_SIZE;
368 rte_pktmbuf_pool_init (mp, &priv);
370 if (rte_eth_dev_count_avail () == 0)
373 iova_mode = rte_eal_iova_mode ();
374 for (i = 0; i < pm->n_pages; i++)
376 size_t page_sz = 1ULL << pm->log2_page_size;
377 char *va = ((char *) pm->base) + i * page_sz;
378 uword pa = iova_mode == RTE_IOVA_VA ?
379 pointer_to_uword (va) : pm->page_table[i];
380 ret = rte_mempool_populate_iova (mp, va, pa, page_sz, 0, 0);
383 rte_mempool_free (mp);
384 return clib_error_return (0, "failed to populate %s", pool_name);
386 /* -1 likely means there is no PCI devices assigned to vfio
387 container or noiommu mode is used so we stop trying */
388 if (map_dma && rte_vfio_dma_map (pointer_to_uword (va), pa, page_sz))
398 dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
401 dpdk_main_t *dm = &dpdk_main;
402 struct rte_mempool *rmp;
403 clib_error_t *error = 0;
408 vec_validate_aligned (dm->pktmbuf_pools, socket_id, CLIB_CACHE_LINE_BYTES);
410 /* pool already exists, nothing to do */
411 if (dm->pktmbuf_pools[socket_id])
414 pool_name = format (0, "dpdk_mbuf_pool_socket%u%c", socket_id, 0);
416 elt_size = sizeof (struct rte_mbuf) +
417 VLIB_BUFFER_HDR_SIZE /* priv size */ +
418 VLIB_BUFFER_PRE_DATA_SIZE + VLIB_BUFFER_DATA_SIZE; /*data room size */
420 error = dpdk_pool_create (vm, pool_name, elt_size, num_mbufs,
421 sizeof (dpdk_mempool_private_t), 512, socket_id,
424 vec_free (pool_name);
428 /* call the object initializers */
429 rte_mempool_obj_iter (rmp, rte_pktmbuf_init, 0);
431 dpdk_mempool_private_t *privp = rte_mempool_get_priv (rmp);
432 privp->buffer_pool_index =
433 vlib_buffer_register_physmem_map (vm, map_index);
435 dm->pktmbuf_pools[socket_id] = rmp;
440 clib_error_report (error);
442 /* no usable pool for this socket, try to use pool from another one */
443 for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
445 if (dm->pktmbuf_pools[i])
447 clib_warning ("WARNING: Failed to allocate mempool for CPU socket "
448 "%u. Threads running on socket %u will use socket %u "
449 "mempool.", socket_id, socket_id, i);
450 dm->pktmbuf_pools[socket_id] = dm->pktmbuf_pools[i];
455 return clib_error_return (0, "failed to allocate mempool on socket %u",
461 u32 *vlib_buffer_state_validation_lock;
462 uword *vlib_buffer_state_validation_hash;
463 void *vlib_buffer_state_heap;
465 static clib_error_t *
466 buffer_state_validation_init (vlib_main_t * vm)
470 vlib_buffer_state_heap =
471 mheap_alloc_with_lock (0, 10 << 20, 0 /* locked */ );
472 oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
474 vlib_buffer_state_validation_hash = hash_create (0, sizeof (uword));
475 vec_validate_aligned (vlib_buffer_state_validation_lock, 0,
476 CLIB_CACHE_LINE_BYTES);
477 clib_mem_set_heap (oldheap);
481 VLIB_INIT_FUNCTION (buffer_state_validation_init);
485 struct dpdk_validate_buf_result
491 #define DPDK_TRAJECTORY_POISON 31
494 dpdk_buffer_validate_trajectory (struct rte_mempool *mp, void *opaque,
495 void *obj, unsigned obj_idx)
498 struct dpdk_validate_buf_result *counter = opaque;
499 b = vlib_buffer_from_rte_mbuf ((struct rte_mbuf *) obj);
500 if (b->pre_data[0] != 0)
502 if (b->pre_data[0] == DPDK_TRAJECTORY_POISON)
503 counter->uninitialized++;
510 dpdk_buffer_validate_trajectory_all (u32 * uninitialized)
512 dpdk_main_t *dm = &dpdk_main;
513 struct dpdk_validate_buf_result counter = { 0 };
516 for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
517 rte_mempool_obj_iter (dm->pktmbuf_pools[i],
518 dpdk_buffer_validate_trajectory, &counter);
520 *uninitialized = counter.uninitialized;
521 return counter.invalid;
525 dpdk_buffer_poison_trajectory (struct rte_mempool *mp, void *opaque,
526 void *obj, unsigned obj_idx)
529 b = vlib_buffer_from_rte_mbuf ((struct rte_mbuf *) obj);
530 b->pre_data[0] = DPDK_TRAJECTORY_POISON;
534 dpdk_buffer_poison_trajectory_all (void)
536 dpdk_main_t *dm = &dpdk_main;
539 for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
540 rte_mempool_obj_iter (dm->pktmbuf_pools[i], dpdk_buffer_poison_trajectory,
545 static clib_error_t *
546 dpdk_buffer_init (vlib_main_t * vm)
548 dpdk_buffer_main_t *dbm = &dpdk_buffer_main;
549 vlib_thread_main_t *tm = vlib_get_thread_main ();
551 vec_validate_aligned (dbm->ptd, tm->n_vlib_mains - 1,
552 CLIB_CACHE_LINE_BYTES);
554 dbm->vfio_container_fd = -1;
559 VLIB_INIT_FUNCTION (dpdk_buffer_init);
562 VLIB_BUFFER_REGISTER_CALLBACKS (dpdk, static) = {
563 .vlib_buffer_fill_free_list_cb = &dpdk_buffer_fill_free_list,
564 .vlib_buffer_free_cb = &dpdk_buffer_free,
565 .vlib_buffer_free_no_next_cb = &dpdk_buffer_free_no_next,
570 vlib_buffer_fill_free_list_cb_t __clib_weak dpdk_buffer_fill_free_list_avx512;
571 vlib_buffer_fill_free_list_cb_t __clib_weak dpdk_buffer_fill_free_list_avx2;
572 vlib_buffer_free_cb_t __clib_weak dpdk_buffer_free_avx512;
573 vlib_buffer_free_cb_t __clib_weak dpdk_buffer_free_avx2;
574 vlib_buffer_free_no_next_cb_t __clib_weak dpdk_buffer_free_no_next_avx512;
575 vlib_buffer_free_no_next_cb_t __clib_weak dpdk_buffer_free_no_next_avx2;
577 static void __clib_constructor
578 dpdk_input_multiarch_select (void)
580 vlib_buffer_callbacks_t *cb = &__dpdk_buffer_callbacks;
581 if (dpdk_buffer_fill_free_list_avx512 && clib_cpu_supports_avx512f ())
583 cb->vlib_buffer_fill_free_list_cb = dpdk_buffer_fill_free_list_avx512;
584 cb->vlib_buffer_free_cb = dpdk_buffer_free_avx512;
585 cb->vlib_buffer_free_no_next_cb = dpdk_buffer_free_no_next_avx512;
587 else if (dpdk_buffer_fill_free_list_avx2 && clib_cpu_supports_avx2 ())
589 cb->vlib_buffer_fill_free_list_cb = dpdk_buffer_fill_free_list_avx2;
590 cb->vlib_buffer_free_cb = dpdk_buffer_free_avx2;
591 cb->vlib_buffer_free_no_next_cb = dpdk_buffer_free_no_next_avx2;
599 * fd.io coding-style-patch-verification: ON
602 * eval: (c-set-style "gnu")