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>
81 STATIC_ASSERT (VLIB_BUFFER_PRE_DATA_SIZE == RTE_PKTMBUF_HEADROOM,
82 "VLIB_BUFFER_PRE_DATA_SIZE must be equal to RTE_PKTMBUF_HEADROOM");
86 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
87 struct rte_mbuf **mbuf_alloc_list;
88 } dpdk_buffer_per_thread_data;
92 int vfio_container_fd;
93 dpdk_buffer_per_thread_data *ptd;
96 dpdk_buffer_main_t dpdk_buffer_main;
98 static_always_inline void
99 dpdk_rte_pktmbuf_free (vlib_main_t * vm, u32 thread_index, vlib_buffer_t * b,
107 next = b->next_buffer;
108 mb = rte_mbuf_from_vlib_buffer (b);
110 if (PREDICT_FALSE (b->n_add_refs))
112 rte_mbuf_refcnt_update (mb, b->n_add_refs);
116 if ((mb = rte_pktmbuf_prefree_seg (mb)))
117 rte_mempool_put (mb->pool, mb);
119 if (maybe_next && (flags & VLIB_BUFFER_NEXT_PRESENT))
121 b = vlib_get_buffer (vm, next);
126 #ifndef CLIB_MARCH_VARIANT
128 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
132 u32 thread_index = vlib_get_thread_index ();
134 for (i = 0; i < vec_len (f->buffers); i++)
136 b = vlib_get_buffer (vm, f->buffers[i]);
137 dpdk_rte_pktmbuf_free (vm, thread_index, b, 1);
141 vec_free (f->buffers);
143 clib_memset (f, 0xab, sizeof (f[0]));
146 /* Add buffer free list. */
148 dpdk_buffer_delete_free_list (vlib_main_t * vm,
149 vlib_buffer_free_list_index_t free_list_index)
151 vlib_buffer_free_list_t *f;
154 ASSERT (vlib_get_thread_index () == 0);
156 f = vlib_buffer_get_free_list (vm, free_list_index);
158 del_free_list (vm, f);
160 pool_put (vm->buffer_free_list_pool, f);
162 for (i = 1; i < vec_len (vlib_mains); i++)
164 vlib_main_t *wvm = vlib_mains[i];
165 f = vlib_buffer_get_free_list (vlib_mains[i], free_list_index);
166 del_free_list (wvm, f);
167 pool_put (wvm->buffer_free_list_pool, f);
172 /* Make sure free list has at least given number of free buffers. */
174 CLIB_MULTIARCH_FN (dpdk_buffer_fill_free_list) (vlib_main_t * vm,
175 vlib_buffer_free_list_t * fl,
176 uword min_free_buffers)
178 dpdk_main_t *dm = &dpdk_main;
179 dpdk_buffer_main_t *dbm = &dpdk_buffer_main;
180 struct rte_mbuf **mb;
183 unsigned socket_id = rte_socket_id ();
184 u32 thread_index = vlib_get_thread_index ();
185 dpdk_buffer_per_thread_data *d = vec_elt_at_index (dbm->ptd, thread_index);
186 struct rte_mempool *rmp = dm->pktmbuf_pools[socket_id];
187 dpdk_mempool_private_t *privp = rte_mempool_get_priv (rmp);
192 if (PREDICT_FALSE (rmp == 0))
195 /* Already have enough free buffers on free list? */
196 n_alloc = min_free_buffers - vec_len (fl->buffers);
198 return min_free_buffers;
200 /* Always allocate round number of buffers. */
201 n_alloc = round_pow2 (n_alloc, CLIB_CACHE_LINE_BYTES / sizeof (u32));
203 /* Always allocate new buffers in reasonably large sized chunks. */
204 n_alloc = clib_max (n_alloc, fl->min_n_buffers_each_alloc);
206 vec_validate_aligned (d->mbuf_alloc_list, n_alloc - 1,
207 CLIB_CACHE_LINE_BYTES);
209 if (rte_mempool_get_bulk (rmp, (void *) d->mbuf_alloc_list, n_alloc) < 0)
212 clib_memset (&bt, 0, sizeof (vlib_buffer_t));
213 vlib_buffer_init_for_free_list (&bt, fl);
214 bt.buffer_pool_index = privp->buffer_pool_index;
216 _vec_len (d->mbuf_alloc_list) = n_alloc;
218 first = vec_len (fl->buffers);
219 vec_resize_aligned (fl->buffers, n_alloc, CLIB_CACHE_LINE_BYTES);
222 mb = d->mbuf_alloc_list;
223 bi = fl->buffers + first;
225 ASSERT (n_left % 8 == 0);
229 if (PREDICT_FALSE (n_left < 24))
232 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[16]), STORE);
233 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[17]), STORE);
234 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[18]), STORE);
235 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[19]), STORE);
236 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[20]), STORE);
237 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[21]), STORE);
238 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[22]), STORE);
239 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (mb[23]), STORE);
242 vlib_get_buffer_indices_with_offset (vm, (void **) mb, bi, 8,
243 sizeof (struct rte_mbuf));
244 clib_memcpy64_x4 (vlib_buffer_from_rte_mbuf (mb[0]),
245 vlib_buffer_from_rte_mbuf (mb[1]),
246 vlib_buffer_from_rte_mbuf (mb[2]),
247 vlib_buffer_from_rte_mbuf (mb[3]), &bt);
248 clib_memcpy64_x4 (vlib_buffer_from_rte_mbuf (mb[4]),
249 vlib_buffer_from_rte_mbuf (mb[5]),
250 vlib_buffer_from_rte_mbuf (mb[6]),
251 vlib_buffer_from_rte_mbuf (mb[7]), &bt);
258 if (fl->buffer_init_function)
259 fl->buffer_init_function (vm, fl, fl->buffers + first, n_alloc);
261 fl->n_alloc += n_alloc;
266 static_always_inline void
267 dpdk_prefetch_buffer (vlib_buffer_t * b)
270 mb = rte_mbuf_from_vlib_buffer (b);
271 CLIB_PREFETCH (mb, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
272 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, LOAD);
275 static_always_inline void
276 recycle_or_free (vlib_main_t * vm, vlib_buffer_main_t * bm, u32 bi,
279 u32 thread_index = vlib_get_thread_index ();
281 dpdk_rte_pktmbuf_free (vm, thread_index, b, 1);
284 static_always_inline void
285 vlib_buffer_free_inline (vlib_main_t * vm,
286 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
288 vlib_buffer_main_t *bm = &buffer_main;
289 vlib_buffer_t *bufp[n_buffers], **b = bufp;
290 u32 thread_index = vlib_get_thread_index ();
292 u32 simple_mask = (VLIB_BUFFER_NON_DEFAULT_FREELIST |
293 VLIB_BUFFER_NEXT_PRESENT);
295 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
296 u32 follow_buffer_next);
298 cb = bm->buffer_free_callback;
300 if (PREDICT_FALSE (cb != 0))
301 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
309 vlib_get_buffers (vm, bi, b, n_buffers);
320 dpdk_prefetch_buffer (p[0]);
321 dpdk_prefetch_buffer (p[1]);
322 dpdk_prefetch_buffer (p[2]);
323 dpdk_prefetch_buffer (p[3]);
326 for (i = 0; i < 4; i++)
327 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[i]);
329 or_flags = b[0]->flags | b[1]->flags | b[2]->flags | b[3]->flags;
331 if (or_flags & simple_mask)
333 recycle_or_free (vm, bm, bi[0], b[0]);
334 recycle_or_free (vm, bm, bi[1], b[1]);
335 recycle_or_free (vm, bm, bi[2], b[2]);
336 recycle_or_free (vm, bm, bi[3], b[3]);
340 dpdk_rte_pktmbuf_free (vm, thread_index, b[0], 0);
341 dpdk_rte_pktmbuf_free (vm, thread_index, b[1], 0);
342 dpdk_rte_pktmbuf_free (vm, thread_index, b[2], 0);
343 dpdk_rte_pktmbuf_free (vm, thread_index, b[3], 0);
351 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
352 recycle_or_free (vm, bm, bi[0], b[0]);
360 CLIB_MULTIARCH_FN (dpdk_buffer_free) (vlib_main_t * vm, u32 * buffers,
363 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
368 CLIB_MULTIARCH_FN (dpdk_buffer_free_no_next) (vlib_main_t * vm, u32 * buffers,
371 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
375 #ifndef CLIB_MARCH_VARIANT
377 dpdk_packet_template_init (vlib_main_t * vm,
380 uword n_packet_data_bytes,
381 uword min_n_buffers_each_alloc, u8 * name)
383 vlib_packet_template_t *t = (vlib_packet_template_t *) vt;
385 vlib_worker_thread_barrier_sync (vm);
386 clib_memset (t, 0, sizeof (t[0]));
388 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
390 vlib_worker_thread_barrier_release (vm);
394 dpdk_pool_create (vlib_main_t * vm, u8 * pool_name, u32 elt_size,
395 u32 num_elts, u32 pool_priv_size, u16 cache_size, u8 numa,
396 struct rte_mempool **_mp, u32 * map_index)
398 struct rte_mempool *mp;
399 enum rte_iova_mode iova_mode;
400 dpdk_mempool_private_t priv;
401 vlib_physmem_map_t *pm;
402 clib_error_t *error = 0;
403 size_t min_chunk_size, align;
409 mp = rte_mempool_create_empty ((char *) pool_name, num_elts, elt_size,
410 512, pool_priv_size, numa, 0);
412 return clib_error_return (0, "failed to create %s", pool_name);
414 rte_mempool_set_ops_byname (mp, RTE_MBUF_DEFAULT_MEMPOOL_OPS, NULL);
416 size = rte_mempool_op_calc_mem_size_default (mp, num_elts, 21,
417 &min_chunk_size, &align);
419 if ((error = vlib_physmem_shared_map_create (vm, (char *) pool_name, size,
420 0, numa, map_index)))
422 rte_mempool_free (mp);
425 pm = vlib_physmem_get_map (vm, *map_index);
427 /* Call the mempool priv initializer */
428 priv.mbp_priv.mbuf_data_room_size = VLIB_BUFFER_PRE_DATA_SIZE +
429 VLIB_BUFFER_DATA_SIZE;
430 priv.mbp_priv.mbuf_priv_size = VLIB_BUFFER_HDR_SIZE;
431 rte_pktmbuf_pool_init (mp, &priv);
433 if (rte_eth_dev_count_avail () == 0)
436 iova_mode = rte_eal_iova_mode ();
437 for (i = 0; i < pm->n_pages; i++)
439 size_t page_sz = 1ULL << pm->log2_page_size;
440 char *va = ((char *) pm->base) + i * page_sz;
441 uword pa = iova_mode == RTE_IOVA_VA ?
442 pointer_to_uword (va) : pm->page_table[i];
443 ret = rte_mempool_populate_iova (mp, va, pa, page_sz, 0, 0);
446 rte_mempool_free (mp);
447 return clib_error_return (0, "failed to populate %s", pool_name);
449 /* -1 likely means there is no PCI devices assigned to vfio
450 container or noiommu mode is used so we stop trying */
451 if (map_dma && rte_vfio_dma_map (pointer_to_uword (va), pa, page_sz))
461 dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
464 dpdk_main_t *dm = &dpdk_main;
465 struct rte_mempool *rmp;
466 clib_error_t *error = 0;
471 vec_validate_aligned (dm->pktmbuf_pools, socket_id, CLIB_CACHE_LINE_BYTES);
473 /* pool already exists, nothing to do */
474 if (dm->pktmbuf_pools[socket_id])
477 pool_name = format (0, "dpdk_mbuf_pool_socket%u%c", socket_id, 0);
479 elt_size = sizeof (struct rte_mbuf) +
480 VLIB_BUFFER_HDR_SIZE /* priv size */ +
481 VLIB_BUFFER_PRE_DATA_SIZE + VLIB_BUFFER_DATA_SIZE; /*data room size */
483 error = dpdk_pool_create (vm, pool_name, elt_size, num_mbufs,
484 sizeof (dpdk_mempool_private_t), 512, socket_id,
487 vec_free (pool_name);
491 /* call the object initializers */
492 rte_mempool_obj_iter (rmp, rte_pktmbuf_init, 0);
494 dpdk_mempool_private_t *privp = rte_mempool_get_priv (rmp);
495 privp->buffer_pool_index =
496 vlib_buffer_register_physmem_map (vm, map_index);
498 dm->pktmbuf_pools[socket_id] = rmp;
503 clib_error_report (error);
505 /* no usable pool for this socket, try to use pool from another one */
506 for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
508 if (dm->pktmbuf_pools[i])
510 clib_warning ("WARNING: Failed to allocate mempool for CPU socket "
511 "%u. Threads running on socket %u will use socket %u "
512 "mempool.", socket_id, socket_id, i);
513 dm->pktmbuf_pools[socket_id] = dm->pktmbuf_pools[i];
518 return clib_error_return (0, "failed to allocate mempool on socket %u",
524 u32 *vlib_buffer_state_validation_lock;
525 uword *vlib_buffer_state_validation_hash;
526 void *vlib_buffer_state_heap;
528 static clib_error_t *
529 buffer_state_validation_init (vlib_main_t * vm)
533 vlib_buffer_state_heap =
534 mheap_alloc_with_lock (0, 10 << 20, 0 /* locked */ );
535 oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
537 vlib_buffer_state_validation_hash = hash_create (0, sizeof (uword));
538 vec_validate_aligned (vlib_buffer_state_validation_lock, 0,
539 CLIB_CACHE_LINE_BYTES);
540 clib_mem_set_heap (oldheap);
544 VLIB_INIT_FUNCTION (buffer_state_validation_init);
548 struct dpdk_validate_buf_result
554 #define DPDK_TRAJECTORY_POISON 31
557 dpdk_buffer_validate_trajectory (struct rte_mempool *mp, void *opaque,
558 void *obj, unsigned obj_idx)
561 struct dpdk_validate_buf_result *counter = opaque;
562 b = vlib_buffer_from_rte_mbuf ((struct rte_mbuf *) obj);
563 if (b->pre_data[0] != 0)
565 if (b->pre_data[0] == DPDK_TRAJECTORY_POISON)
566 counter->uninitialized++;
573 dpdk_buffer_validate_trajectory_all (u32 * uninitialized)
575 dpdk_main_t *dm = &dpdk_main;
576 struct dpdk_validate_buf_result counter = { 0 };
579 for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
580 rte_mempool_obj_iter (dm->pktmbuf_pools[i],
581 dpdk_buffer_validate_trajectory, &counter);
583 *uninitialized = counter.uninitialized;
584 return counter.invalid;
588 dpdk_buffer_poison_trajectory (struct rte_mempool *mp, void *opaque,
589 void *obj, unsigned obj_idx)
592 b = vlib_buffer_from_rte_mbuf ((struct rte_mbuf *) obj);
593 b->pre_data[0] = DPDK_TRAJECTORY_POISON;
597 dpdk_buffer_poison_trajectory_all (void)
599 dpdk_main_t *dm = &dpdk_main;
602 for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
603 rte_mempool_obj_iter (dm->pktmbuf_pools[i], dpdk_buffer_poison_trajectory,
608 static clib_error_t *
609 dpdk_buffer_init (vlib_main_t * vm)
611 dpdk_buffer_main_t *dbm = &dpdk_buffer_main;
612 vlib_thread_main_t *tm = vlib_get_thread_main ();
614 vec_validate_aligned (dbm->ptd, tm->n_vlib_mains - 1,
615 CLIB_CACHE_LINE_BYTES);
617 dbm->vfio_container_fd = -1;
622 VLIB_INIT_FUNCTION (dpdk_buffer_init);
625 VLIB_BUFFER_REGISTER_CALLBACKS (dpdk, static) = {
626 .vlib_buffer_fill_free_list_cb = &dpdk_buffer_fill_free_list,
627 .vlib_buffer_free_cb = &dpdk_buffer_free,
628 .vlib_buffer_free_no_next_cb = &dpdk_buffer_free_no_next,
629 .vlib_packet_template_init_cb = &dpdk_packet_template_init,
630 .vlib_buffer_delete_free_list_cb = &dpdk_buffer_delete_free_list,
635 vlib_buffer_fill_free_list_cb_t __clib_weak dpdk_buffer_fill_free_list_avx512;
636 vlib_buffer_fill_free_list_cb_t __clib_weak dpdk_buffer_fill_free_list_avx2;
637 vlib_buffer_free_cb_t __clib_weak dpdk_buffer_free_avx512;
638 vlib_buffer_free_cb_t __clib_weak dpdk_buffer_free_avx2;
639 vlib_buffer_free_no_next_cb_t __clib_weak dpdk_buffer_free_no_next_avx512;
640 vlib_buffer_free_no_next_cb_t __clib_weak dpdk_buffer_free_no_next_avx2;
642 static void __clib_constructor
643 dpdk_input_multiarch_select (void)
645 vlib_buffer_callbacks_t *cb = &__dpdk_buffer_callbacks;
646 if (dpdk_buffer_fill_free_list_avx512 && clib_cpu_supports_avx512f ())
648 cb->vlib_buffer_fill_free_list_cb = dpdk_buffer_fill_free_list_avx512;
649 cb->vlib_buffer_free_cb = dpdk_buffer_free_avx512;
650 cb->vlib_buffer_free_no_next_cb = dpdk_buffer_free_no_next_avx512;
652 else if (dpdk_buffer_fill_free_list_avx2 && clib_cpu_supports_avx2 ())
654 cb->vlib_buffer_fill_free_list_cb = dpdk_buffer_fill_free_list_avx2;
655 cb->vlib_buffer_free_cb = dpdk_buffer_free_avx2;
656 cb->vlib_buffer_free_no_next_cb = dpdk_buffer_free_no_next_avx2;
664 * fd.io coding-style-patch-verification: ON
667 * eval: (c-set-style "gnu")