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 <dpdk/device/dpdk.h>
76 #include <dpdk/device/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 static struct rte_mbuf ***mbuf_pending_free_list = 0;
84 static_always_inline void
85 dpdk_rte_pktmbuf_free (vlib_main_t * vm, vlib_buffer_t * b)
87 vlib_buffer_t *hb = b;
90 mb = rte_mbuf_from_vlib_buffer (hb);
91 static struct rte_mempool *last_pool = 0;
92 static u8 last_buffer_pool_index;
96 next = b->next_buffer;
97 mb = rte_mbuf_from_vlib_buffer (b);
99 if (PREDICT_FALSE (b->n_add_refs))
101 rte_mbuf_refcnt_update (mb, b->n_add_refs);
105 mb = rte_pktmbuf_prefree_seg (mb);
108 if (mb->pool != last_pool)
110 last_pool = mb->pool;
111 dpdk_mempool_private_t *privp = rte_mempool_get_priv (last_pool);
112 last_buffer_pool_index = privp->buffer_pool_index;
113 vec_validate_aligned (mbuf_pending_free_list,
114 last_buffer_pool_index,
115 CLIB_CACHE_LINE_BYTES);
117 vec_add1 (mbuf_pending_free_list[last_buffer_pool_index], mb);
120 if (flags & VLIB_BUFFER_NEXT_PRESENT)
122 b = vlib_get_buffer (vm, next);
128 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
133 for (i = 0; i < vec_len (f->buffers); i++)
135 b = vlib_get_buffer (vm, f->buffers[i]);
136 dpdk_rte_pktmbuf_free (vm, b);
140 vec_free (f->buffers);
143 /* Add buffer free list. */
145 dpdk_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index)
147 vlib_buffer_main_t *bm = vm->buffer_main;
148 vlib_buffer_free_list_t *f;
152 ASSERT (vlib_get_thread_index () == 0);
154 f = vlib_buffer_get_free_list (vm, free_list_index);
156 merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
157 if (merge_index != ~0 && merge_index != free_list_index)
159 vlib_buffer_merge_free_lists (pool_elt_at_index
160 (bm->buffer_free_list_pool, merge_index),
164 del_free_list (vm, f);
167 memset (f, 0xab, sizeof (f[0]));
169 pool_put (bm->buffer_free_list_pool, f);
171 for (i = 1; i < vec_len (vlib_mains); i++)
173 bm = vlib_mains[i]->buffer_main;
174 f = vlib_buffer_get_free_list (vlib_mains[i], free_list_index);;
175 memset (f, 0xab, sizeof (f[0]));
176 pool_put (bm->buffer_free_list_pool, f);
180 /* Make sure free list has at least given number of free buffers. */
182 fill_free_list (vlib_main_t * vm,
183 vlib_buffer_free_list_t * fl, uword min_free_buffers)
185 dpdk_main_t *dm = &dpdk_main;
186 vlib_buffer_t *b0, *b1, *b2, *b3;
188 u32 bi0, bi1, bi2, bi3;
189 unsigned socket_id = rte_socket_id ();
190 struct rte_mempool *rmp = dm->pktmbuf_pools[socket_id];
191 dpdk_mempool_private_t *privp = rte_mempool_get_priv (rmp);
192 struct rte_mbuf *mb0, *mb1, *mb2, *mb3;
196 if (PREDICT_FALSE (rmp == 0))
199 /* Already have enough free buffers on free list? */
200 n = min_free_buffers - vec_len (fl->buffers);
202 return min_free_buffers;
204 /* Always allocate round number of buffers. */
205 n = round_pow2 (n, CLIB_CACHE_LINE_BYTES / sizeof (u32));
207 /* Always allocate new buffers in reasonably large sized chunks. */
208 n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
210 vec_validate_aligned (vm->mbuf_alloc_list, n - 1, CLIB_CACHE_LINE_BYTES);
212 if (rte_mempool_get_bulk (rmp, vm->mbuf_alloc_list, n) < 0)
215 memset (&bt, 0, sizeof (vlib_buffer_t));
216 vlib_buffer_init_for_free_list (&bt, fl);
217 bt.buffer_pool_index = privp->buffer_pool_index;
219 _vec_len (vm->mbuf_alloc_list) = n;
222 int f = vec_len (fl->buffers);
223 vec_resize_aligned (fl->buffers, n, CLIB_CACHE_LINE_BYTES);
227 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
228 (vm->mbuf_alloc_list[i + 4]), STORE);
229 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
230 (vm->mbuf_alloc_list[i + 5]), STORE);
231 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
232 (vm->mbuf_alloc_list[i + 6]), STORE);
233 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
234 (vm->mbuf_alloc_list[i + 7]), STORE);
236 mb0 = vm->mbuf_alloc_list[i];
237 mb1 = vm->mbuf_alloc_list[i + 1];
238 mb2 = vm->mbuf_alloc_list[i + 2];
239 mb3 = vm->mbuf_alloc_list[i + 3];
241 b0 = vlib_buffer_from_rte_mbuf (mb0);
242 b1 = vlib_buffer_from_rte_mbuf (mb1);
243 b2 = vlib_buffer_from_rte_mbuf (mb2);
244 b3 = vlib_buffer_from_rte_mbuf (mb3);
246 bi0 = vlib_get_buffer_index (vm, b0);
247 bi1 = vlib_get_buffer_index (vm, b1);
248 bi2 = vlib_get_buffer_index (vm, b2);
249 bi3 = vlib_get_buffer_index (vm, b3);
251 fl->buffers[f++] = bi0;
252 fl->buffers[f++] = bi1;
253 fl->buffers[f++] = bi2;
254 fl->buffers[f++] = bi3;
256 clib_memcpy (b0, &bt, sizeof (vlib_buffer_t));
257 clib_memcpy (b1, &bt, sizeof (vlib_buffer_t));
258 clib_memcpy (b2, &bt, sizeof (vlib_buffer_t));
259 clib_memcpy (b3, &bt, sizeof (vlib_buffer_t));
261 if (fl->buffer_init_function)
263 fl->buffer_init_function (vm, fl, &bi0, 1);
264 fl->buffer_init_function (vm, fl, &bi1, 1);
265 fl->buffer_init_function (vm, fl, &bi2, 1);
266 fl->buffer_init_function (vm, fl, &bi3, 1);
273 mb0 = vm->mbuf_alloc_list[i];
275 b0 = vlib_buffer_from_rte_mbuf (mb0);
276 bi0 = vlib_get_buffer_index (vm, b0);
278 fl->buffers[f++] = bi0;
279 clib_memcpy (b0, &bt, sizeof (vlib_buffer_t));
281 if (fl->buffer_init_function)
282 fl->buffer_init_function (vm, fl, &bi0, 1);
292 alloc_from_free_list (vlib_main_t * vm,
293 vlib_buffer_free_list_t * free_list,
294 u32 * alloc_buffers, u32 n_alloc_buffers)
301 n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
305 len = vec_len (free_list->buffers);
306 ASSERT (len >= n_alloc_buffers);
308 src = free_list->buffers + len - n_alloc_buffers;
309 clib_memcpy (dst, src, n_alloc_buffers * sizeof (u32));
311 _vec_len (free_list->buffers) -= n_alloc_buffers;
313 return n_alloc_buffers;
316 /* Allocate a given number of buffers into given array.
317 Returns number actually allocated which will be either zero or
320 dpdk_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
322 vlib_buffer_main_t *bm = vm->buffer_main;
324 return alloc_from_free_list
326 pool_elt_at_index (bm->buffer_free_list_pool,
327 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
333 dpdk_buffer_alloc_from_free_list (vlib_main_t * vm,
335 u32 n_buffers, u32 free_list_index)
337 vlib_buffer_main_t *bm = vm->buffer_main;
338 vlib_buffer_free_list_t *f;
339 f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
340 return alloc_from_free_list (vm, f, buffers, n_buffers);
343 static_always_inline void
344 dpdk_prefetch_buffer_by_index (vlib_main_t * vm, u32 bi)
348 b = vlib_get_buffer (vm, bi);
349 mb = rte_mbuf_from_vlib_buffer (b);
350 CLIB_PREFETCH (mb, CLIB_CACHE_LINE_BYTES, STORE);
351 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, LOAD);
354 static_always_inline void
355 recycle_or_free (vlib_main_t * vm, vlib_buffer_main_t * bm, u32 bi,
358 vlib_buffer_free_list_t *fl;
360 fl = vlib_buffer_get_buffer_free_list (vm, b, &fi);
362 /* The only current use of this callback: multicast recycle */
363 if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
367 vlib_buffer_add_to_free_list (vm, fl, bi,
368 (b->flags & VLIB_BUFFER_RECYCLE) == 0);
370 for (j = 0; j < vec_len (bm->announce_list); j++)
372 if (fl == bm->announce_list[j])
373 goto already_announced;
375 vec_add1 (bm->announce_list, fl);
381 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0))
382 dpdk_rte_pktmbuf_free (vm, b);
386 static_always_inline void
387 vlib_buffer_free_inline (vlib_main_t * vm,
388 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
390 vlib_buffer_main_t *bm = vm->buffer_main;
391 vlib_buffer_t *b0, *b1, *b2, *b3;
393 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
394 u32 follow_buffer_next);
396 cb = bm->buffer_free_callback;
398 if (PREDICT_FALSE (cb != 0))
399 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
404 while (i + 7 < n_buffers)
406 dpdk_prefetch_buffer_by_index (vm, buffers[i + 4]);
407 dpdk_prefetch_buffer_by_index (vm, buffers[i + 5]);
408 dpdk_prefetch_buffer_by_index (vm, buffers[i + 6]);
409 dpdk_prefetch_buffer_by_index (vm, buffers[i + 7]);
411 b0 = vlib_get_buffer (vm, buffers[i]);
412 b1 = vlib_get_buffer (vm, buffers[i + 1]);
413 b2 = vlib_get_buffer (vm, buffers[i + 2]);
414 b3 = vlib_get_buffer (vm, buffers[i + 3]);
416 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
417 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
418 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b2);
419 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b3);
421 recycle_or_free (vm, bm, buffers[i], b0);
422 recycle_or_free (vm, bm, buffers[i + 1], b1);
423 recycle_or_free (vm, bm, buffers[i + 2], b2);
424 recycle_or_free (vm, bm, buffers[i + 3], b3);
428 while (i < n_buffers)
430 b0 = vlib_get_buffer (vm, buffers[i]);
431 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
432 recycle_or_free (vm, bm, buffers[i], b0);
435 if (vec_len (bm->announce_list))
437 vlib_buffer_free_list_t *fl;
438 for (i = 0; i < vec_len (bm->announce_list); i++)
440 fl = bm->announce_list[i];
441 fl->buffers_added_to_freelist_function (vm, fl);
443 _vec_len (bm->announce_list) = 0;
446 vec_foreach_index (i, mbuf_pending_free_list)
448 int len = vec_len (mbuf_pending_free_list[i]);
451 rte_mempool_put_bulk (mbuf_pending_free_list[i][len - 1]->pool,
452 (void *) mbuf_pending_free_list[i], len);
453 vec_reset_length (mbuf_pending_free_list[i]);
459 dpdk_buffer_free (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
461 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
466 dpdk_buffer_free_no_next (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
468 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
473 dpdk_packet_template_init (vlib_main_t * vm,
476 uword n_packet_data_bytes,
477 uword min_n_buffers_each_physmem_alloc, u8 * name)
479 vlib_packet_template_t *t = (vlib_packet_template_t *) vt;
481 vlib_worker_thread_barrier_sync (vm);
482 memset (t, 0, sizeof (t[0]));
484 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
486 vlib_worker_thread_barrier_release (vm);
490 dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
493 dpdk_main_t *dm = &dpdk_main;
494 struct rte_mempool *rmp;
495 dpdk_mempool_private_t priv;
496 vlib_physmem_region_t *pr;
497 vlib_physmem_region_index_t pri;
503 vec_validate_aligned (dm->pktmbuf_pools, socket_id, CLIB_CACHE_LINE_BYTES);
505 /* pool already exists, nothing to do */
506 if (dm->pktmbuf_pools[socket_id])
509 pool_name = format (0, "dpdk_mbuf_pool_socket%u%c", socket_id, 0);
511 elt_size = sizeof (struct rte_mbuf) +
512 VLIB_BUFFER_HDR_SIZE /* priv size */ +
513 VLIB_BUFFER_PRE_DATA_SIZE + VLIB_BUFFER_DATA_SIZE; /*data room size */
515 obj_size = rte_mempool_calc_obj_size (elt_size, 0, 0);
516 size = rte_mempool_xmem_size (num_mbufs, obj_size, 21);
518 clib_error_t *error = 0;
519 error = vlib_physmem_region_alloc (vm, (char *) pool_name, size, socket_id,
522 clib_error_report (error);
524 pr = vlib_physmem_get_region (vm, pri);
526 priv.mbp_priv.mbuf_data_room_size = VLIB_BUFFER_PRE_DATA_SIZE +
527 VLIB_BUFFER_DATA_SIZE;
528 priv.mbp_priv.mbuf_priv_size = VLIB_BUFFER_HDR_SIZE;
531 /* Check that pg_shift parameter is valid. */
532 if (pg_shift > MEMPOOL_PG_SHIFT_MAX)
538 rmp = rte_mempool_create_empty ((char *) pool_name, /* pool name */
539 num_mbufs, /* number of mbufs */
540 elt_size, 512, /* cache size */
541 sizeof (dpdk_mempool_private_t), /* private data size */
542 socket_id, 0); /* flags */
545 rte_mempool_set_ops_byname (rmp, RTE_MBUF_DEFAULT_MEMPOOL_OPS, NULL);
547 /* call the mempool priv initializer */
548 rte_pktmbuf_pool_init (rmp, &priv);
550 ret = rte_mempool_populate_phys_tab (rmp, pr->mem, pr->page_table,
551 pr->n_pages, pr->log2_page_size,
553 if (ret == (i32) rmp->size)
555 /* call the object initializers */
556 rte_mempool_obj_iter (rmp, rte_pktmbuf_init, 0);
558 dpdk_mempool_private_t *privp = rte_mempool_get_priv (rmp);
559 privp->buffer_pool_index = vlib_buffer_add_physmem_region (vm, pri);
561 dm->pktmbuf_pools[socket_id] = rmp;
566 rte_mempool_free (rmp);
569 vec_free (pool_name);
571 /* no usable pool for this socket, try to use pool from another one */
572 for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
574 if (dm->pktmbuf_pools[i])
576 clib_warning ("WARNING: Failed to allocate mempool for CPU socket "
577 "%u. Threads running on socket %u will use socket %u "
578 "mempool.", socket_id, socket_id, i);
579 dm->pktmbuf_pools[socket_id] = dm->pktmbuf_pools[i];
584 return clib_error_return (0, "failed to allocate mempool on socket %u",
590 u32 *vlib_buffer_state_validation_lock;
591 uword *vlib_buffer_state_validation_hash;
592 void *vlib_buffer_state_heap;
594 static clib_error_t *
595 buffer_state_validation_init (vlib_main_t * vm)
599 vlib_buffer_state_heap = mheap_alloc (0, 10 << 20);
601 oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
603 vlib_buffer_state_validation_hash = hash_create (0, sizeof (uword));
604 vec_validate_aligned (vlib_buffer_state_validation_lock, 0,
605 CLIB_CACHE_LINE_BYTES);
606 clib_mem_set_heap (oldheap);
610 VLIB_INIT_FUNCTION (buffer_state_validation_init);
614 struct dpdk_validate_buf_result
620 #define DPDK_TRAJECTORY_POISON 31
623 dpdk_buffer_validate_trajectory (struct rte_mempool *mp, void *opaque,
624 void *obj, unsigned obj_idx)
627 struct dpdk_validate_buf_result *counter = opaque;
628 b = vlib_buffer_from_rte_mbuf ((struct rte_mbuf *) obj);
629 if (b->pre_data[0] != 0)
631 if (b->pre_data[0] == DPDK_TRAJECTORY_POISON)
632 counter->uninitialized++;
639 dpdk_buffer_validate_trajectory_all (u32 * uninitialized)
641 dpdk_main_t *dm = &dpdk_main;
642 struct dpdk_validate_buf_result counter = { 0 };
645 for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
646 rte_mempool_obj_iter (dm->pktmbuf_pools[i],
647 dpdk_buffer_validate_trajectory, &counter);
649 *uninitialized = counter.uninitialized;
650 return counter.invalid;
654 dpdk_buffer_poison_trajectory (struct rte_mempool *mp, void *opaque,
655 void *obj, unsigned obj_idx)
658 b = vlib_buffer_from_rte_mbuf ((struct rte_mbuf *) obj);
659 b->pre_data[0] = DPDK_TRAJECTORY_POISON;
663 dpdk_buffer_poison_trajectory_all (void)
665 dpdk_main_t *dm = &dpdk_main;
668 for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
669 rte_mempool_obj_iter (dm->pktmbuf_pools[i], dpdk_buffer_poison_trajectory,
675 VLIB_BUFFER_REGISTER_CALLBACKS (dpdk, static) = {
676 .vlib_buffer_alloc_cb = &dpdk_buffer_alloc,
677 .vlib_buffer_alloc_from_free_list_cb = &dpdk_buffer_alloc_from_free_list,
678 .vlib_buffer_free_cb = &dpdk_buffer_free,
679 .vlib_buffer_free_no_next_cb = &dpdk_buffer_free_no_next,
680 .vlib_packet_template_init_cb = &dpdk_packet_template_init,
681 .vlib_buffer_delete_free_list_cb = &dpdk_buffer_delete_free_list,
687 * fd.io coding-style-patch-verification: ON
690 * eval: (c-set-style "gnu")