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_always_inline void
83 dpdk_rte_pktmbuf_free (vlib_main_t * vm, vlib_buffer_t * b)
85 vlib_buffer_t *hb = b;
88 mb = rte_mbuf_from_vlib_buffer (hb);
92 next = b->next_buffer;
93 mb = rte_mbuf_from_vlib_buffer (b);
95 if (PREDICT_FALSE (b->n_add_refs))
97 rte_mbuf_refcnt_update (mb, b->n_add_refs);
101 rte_pktmbuf_free_seg (mb);
103 if (flags & VLIB_BUFFER_NEXT_PRESENT)
105 b = vlib_get_buffer (vm, next);
111 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
116 for (i = 0; i < vec_len (f->buffers); i++)
118 b = vlib_get_buffer (vm, f->buffers[i]);
119 dpdk_rte_pktmbuf_free (vm, b);
123 vec_free (f->buffers);
126 /* Add buffer free list. */
128 dpdk_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index)
130 vlib_buffer_main_t *bm = vm->buffer_main;
131 vlib_buffer_free_list_t *f;
135 ASSERT (vlib_get_thread_index () == 0);
137 f = vlib_buffer_get_free_list (vm, free_list_index);
139 merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
140 if (merge_index != ~0 && merge_index != free_list_index)
142 vlib_buffer_merge_free_lists (pool_elt_at_index
143 (bm->buffer_free_list_pool, merge_index),
147 del_free_list (vm, f);
150 memset (f, 0xab, sizeof (f[0]));
152 pool_put (bm->buffer_free_list_pool, f);
154 for (i = 1; i < vec_len (vlib_mains); i++)
156 bm = vlib_mains[i]->buffer_main;
157 f = vlib_buffer_get_free_list (vlib_mains[i], free_list_index);;
158 memset (f, 0xab, sizeof (f[0]));
159 pool_put (bm->buffer_free_list_pool, f);
163 /* Make sure free list has at least given number of free buffers. */
165 fill_free_list (vlib_main_t * vm,
166 vlib_buffer_free_list_t * fl, uword min_free_buffers)
168 dpdk_main_t *dm = &dpdk_main;
169 vlib_buffer_t *b0, *b1, *b2, *b3;
171 u32 bi0, bi1, bi2, bi3;
172 unsigned socket_id = rte_socket_id ();
173 struct rte_mempool *rmp = dm->pktmbuf_pools[socket_id];
174 struct rte_mbuf *mb0, *mb1, *mb2, *mb3;
177 if (PREDICT_FALSE (rmp == 0))
180 /* Already have enough free buffers on free list? */
181 n = min_free_buffers - vec_len (fl->buffers);
183 return min_free_buffers;
185 /* Always allocate round number of buffers. */
186 n = round_pow2 (n, CLIB_CACHE_LINE_BYTES / sizeof (u32));
188 /* Always allocate new buffers in reasonably large sized chunks. */
189 n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
191 vec_validate_aligned (vm->mbuf_alloc_list, n - 1, CLIB_CACHE_LINE_BYTES);
193 if (rte_mempool_get_bulk (rmp, vm->mbuf_alloc_list, n) < 0)
196 _vec_len (vm->mbuf_alloc_list) = n;
202 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
203 (vm->mbuf_alloc_list[i + 4]), STORE);
204 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
205 (vm->mbuf_alloc_list[i + 5]), STORE);
206 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
207 (vm->mbuf_alloc_list[i + 6]), STORE);
208 vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
209 (vm->mbuf_alloc_list[i + 7]), STORE);
211 mb0 = vm->mbuf_alloc_list[i];
212 mb1 = vm->mbuf_alloc_list[i + 1];
213 mb2 = vm->mbuf_alloc_list[i + 2];
214 mb3 = vm->mbuf_alloc_list[i + 3];
216 b0 = vlib_buffer_from_rte_mbuf (mb0);
217 b1 = vlib_buffer_from_rte_mbuf (mb1);
218 b2 = vlib_buffer_from_rte_mbuf (mb2);
219 b3 = vlib_buffer_from_rte_mbuf (mb3);
221 bi0 = vlib_get_buffer_index (vm, b0);
222 bi1 = vlib_get_buffer_index (vm, b1);
223 bi2 = vlib_get_buffer_index (vm, b2);
224 bi3 = vlib_get_buffer_index (vm, b3);
226 vec_add1_aligned (fl->buffers, bi0, CLIB_CACHE_LINE_BYTES);
227 vec_add1_aligned (fl->buffers, bi1, CLIB_CACHE_LINE_BYTES);
228 vec_add1_aligned (fl->buffers, bi2, CLIB_CACHE_LINE_BYTES);
229 vec_add1_aligned (fl->buffers, bi3, CLIB_CACHE_LINE_BYTES);
231 vlib_buffer_init_for_free_list (b0, fl);
232 vlib_buffer_init_for_free_list (b1, fl);
233 vlib_buffer_init_for_free_list (b2, fl);
234 vlib_buffer_init_for_free_list (b3, fl);
236 if (fl->buffer_init_function)
238 fl->buffer_init_function (vm, fl, &bi0, 1);
239 fl->buffer_init_function (vm, fl, &bi1, 1);
240 fl->buffer_init_function (vm, fl, &bi2, 1);
241 fl->buffer_init_function (vm, fl, &bi3, 1);
248 mb0 = vm->mbuf_alloc_list[i];
250 b0 = vlib_buffer_from_rte_mbuf (mb0);
251 bi0 = vlib_get_buffer_index (vm, b0);
253 vec_add1_aligned (fl->buffers, bi0, CLIB_CACHE_LINE_BYTES);
255 vlib_buffer_init_for_free_list (b0, fl);
257 if (fl->buffer_init_function)
258 fl->buffer_init_function (vm, fl, &bi0, 1);
268 alloc_from_free_list (vlib_main_t * vm,
269 vlib_buffer_free_list_t * free_list,
270 u32 * alloc_buffers, u32 n_alloc_buffers)
277 n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
281 len = vec_len (free_list->buffers);
282 ASSERT (len >= n_alloc_buffers);
284 src = free_list->buffers + len - n_alloc_buffers;
285 clib_memcpy (dst, src, n_alloc_buffers * sizeof (u32));
287 _vec_len (free_list->buffers) -= n_alloc_buffers;
289 return n_alloc_buffers;
292 /* Allocate a given number of buffers into given array.
293 Returns number actually allocated which will be either zero or
296 dpdk_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
298 vlib_buffer_main_t *bm = vm->buffer_main;
300 return alloc_from_free_list
302 pool_elt_at_index (bm->buffer_free_list_pool,
303 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
309 dpdk_buffer_alloc_from_free_list (vlib_main_t * vm,
311 u32 n_buffers, u32 free_list_index)
313 vlib_buffer_main_t *bm = vm->buffer_main;
314 vlib_buffer_free_list_t *f;
315 f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
316 return alloc_from_free_list (vm, f, buffers, n_buffers);
319 static_always_inline void
320 vlib_buffer_free_inline (vlib_main_t * vm,
321 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
323 vlib_buffer_main_t *bm = vm->buffer_main;
324 vlib_buffer_free_list_t *fl;
327 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
328 u32 follow_buffer_next);
330 cb = bm->buffer_free_callback;
332 if (PREDICT_FALSE (cb != 0))
333 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
338 for (i = 0; i < n_buffers; i++)
342 b = vlib_get_buffer (vm, buffers[i]);
343 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
344 fl = vlib_buffer_get_buffer_free_list (vm, b, &fi);
346 /* The only current use of this callback: multicast recycle */
347 if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
351 vlib_buffer_add_to_free_list
352 (vm, fl, buffers[i], (b->flags & VLIB_BUFFER_RECYCLE) == 0);
354 for (j = 0; j < vec_len (bm->announce_list); j++)
356 if (fl == bm->announce_list[j])
357 goto already_announced;
359 vec_add1 (bm->announce_list, fl);
365 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0))
366 dpdk_rte_pktmbuf_free (vm, b);
369 if (vec_len (bm->announce_list))
371 vlib_buffer_free_list_t *fl;
372 for (i = 0; i < vec_len (bm->announce_list); i++)
374 fl = bm->announce_list[i];
375 fl->buffers_added_to_freelist_function (vm, fl);
377 _vec_len (bm->announce_list) = 0;
382 dpdk_buffer_free (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
384 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
389 dpdk_buffer_free_no_next (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
391 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
396 dpdk_packet_template_init (vlib_main_t * vm,
399 uword n_packet_data_bytes,
400 uword min_n_buffers_each_physmem_alloc, u8 * name)
402 vlib_packet_template_t *t = (vlib_packet_template_t *) vt;
404 vlib_worker_thread_barrier_sync (vm);
405 memset (t, 0, sizeof (t[0]));
407 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
409 vlib_worker_thread_barrier_release (vm);
415 struct rte_pktmbuf_pool_private mbp_priv;
416 vlib_physmem_region_index_t region_index;
417 } dpdk_mempool_private_t;
420 dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
423 dpdk_main_t *dm = &dpdk_main;
424 struct rte_mempool *rmp;
425 dpdk_mempool_private_t priv;
426 vlib_physmem_region_t *pr;
427 vlib_physmem_region_index_t pri;
433 vec_validate_aligned (dm->pktmbuf_pools, socket_id, CLIB_CACHE_LINE_BYTES);
435 /* pool already exists, nothing to do */
436 if (dm->pktmbuf_pools[socket_id])
439 pool_name = format (0, "dpdk_mbuf_pool_socket%u%c", socket_id, 0);
441 elt_size = sizeof (struct rte_mbuf) +
442 VLIB_BUFFER_HDR_SIZE /* priv size */ +
443 VLIB_BUFFER_PRE_DATA_SIZE + VLIB_BUFFER_DATA_SIZE; /*data room size */
445 obj_size = rte_mempool_calc_obj_size (elt_size, 0, 0);
446 size = rte_mempool_xmem_size (num_mbufs, obj_size, 21);
448 clib_error_t *error = 0;
450 vlib_physmem_region_alloc (vm, (char *) pool_name, size, socket_id,
451 VLIB_PHYSMEM_F_HAVE_BUFFERS, &pri);
453 clib_error_report (error);
455 pr = vlib_physmem_get_region (vm, pri);
457 priv.mbp_priv.mbuf_data_room_size = VLIB_BUFFER_PRE_DATA_SIZE +
458 VLIB_BUFFER_DATA_SIZE;
459 priv.mbp_priv.mbuf_priv_size = VLIB_BUFFER_HDR_SIZE;
462 /* Check that pg_shift parameter is valid. */
463 if (pg_shift > MEMPOOL_PG_SHIFT_MAX)
469 rmp = rte_mempool_create_empty ((char *) pool_name, /* pool name */
470 num_mbufs, /* number of mbufs */
471 elt_size, 512, /* cache size */
472 sizeof (dpdk_mempool_private_t), /* private data size */
473 socket_id, 0); /* flags */
476 rte_mempool_set_ops_byname (rmp, RTE_MBUF_DEFAULT_MEMPOOL_OPS, NULL);
478 /* call the mempool priv initializer */
479 rte_pktmbuf_pool_init (rmp, &priv);
481 ret = rte_mempool_populate_phys_tab (rmp, pr->mem, pr->page_table,
482 pr->n_pages, pr->log2_page_size,
484 if (ret == (i32) rmp->size)
486 /* call the object initializers */
487 rte_mempool_obj_iter (rmp, rte_pktmbuf_init, 0);
489 dpdk_mempool_private_t *privp = rte_mempool_get_priv (rmp);
490 privp->region_index = pri;
492 dm->pktmbuf_pools[socket_id] = rmp;
497 rte_mempool_free (rmp);
500 vec_free (pool_name);
502 /* no usable pool for this socket, try to use pool from another one */
503 for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
505 if (dm->pktmbuf_pools[i])
507 clib_warning ("WARNING: Failed to allocate mempool for CPU socket "
508 "%u. Threads running on socket %u will use socket %u "
509 "mempool.", socket_id, socket_id, i);
510 dm->pktmbuf_pools[socket_id] = dm->pktmbuf_pools[i];
515 return clib_error_return (0, "failed to allocate mempool on socket %u",
521 u32 *vlib_buffer_state_validation_lock;
522 uword *vlib_buffer_state_validation_hash;
523 void *vlib_buffer_state_heap;
525 static clib_error_t *
526 buffer_state_validation_init (vlib_main_t * vm)
530 vlib_buffer_state_heap = mheap_alloc (0, 10 << 20);
532 oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
534 vlib_buffer_state_validation_hash = hash_create (0, sizeof (uword));
535 vec_validate_aligned (vlib_buffer_state_validation_lock, 0,
536 CLIB_CACHE_LINE_BYTES);
537 clib_mem_set_heap (oldheap);
541 VLIB_INIT_FUNCTION (buffer_state_validation_init);
545 struct dpdk_validate_buf_result
551 #define DPDK_TRAJECTORY_POISON 31
554 dpdk_buffer_validate_trajectory (struct rte_mempool *mp, void *opaque,
555 void *obj, unsigned obj_idx)
558 struct dpdk_validate_buf_result *counter = opaque;
559 b = vlib_buffer_from_rte_mbuf ((struct rte_mbuf *) obj);
560 if (b->pre_data[0] != 0)
562 if (b->pre_data[0] == DPDK_TRAJECTORY_POISON)
563 counter->uninitialized++;
570 dpdk_buffer_validate_trajectory_all (u32 * uninitialized)
572 dpdk_main_t *dm = &dpdk_main;
573 struct dpdk_validate_buf_result counter = { 0 };
576 for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
577 rte_mempool_obj_iter (dm->pktmbuf_pools[i],
578 dpdk_buffer_validate_trajectory, &counter);
580 *uninitialized = counter.uninitialized;
581 return counter.invalid;
585 dpdk_buffer_poison_trajectory (struct rte_mempool *mp, void *opaque,
586 void *obj, unsigned obj_idx)
589 b = vlib_buffer_from_rte_mbuf ((struct rte_mbuf *) obj);
590 b->pre_data[0] = DPDK_TRAJECTORY_POISON;
594 dpdk_buffer_poison_trajectory_all (void)
596 dpdk_main_t *dm = &dpdk_main;
599 for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
600 rte_mempool_obj_iter (dm->pktmbuf_pools[i], dpdk_buffer_poison_trajectory,
606 VLIB_BUFFER_REGISTER_CALLBACKS (dpdk, static) = {
607 .vlib_buffer_alloc_cb = &dpdk_buffer_alloc,
608 .vlib_buffer_alloc_from_free_list_cb = &dpdk_buffer_alloc_from_free_list,
609 .vlib_buffer_free_cb = &dpdk_buffer_free,
610 .vlib_buffer_free_no_next_cb = &dpdk_buffer_free_no_next,
611 .vlib_packet_template_init_cb = &dpdk_packet_template_init,
612 .vlib_buffer_delete_free_list_cb = &dpdk_buffer_delete_free_list,
618 * fd.io coding-style-patch-verification: ON
621 * eval: (c-set-style "gnu")