/* * Copyright (c) 2017 Cisco and/or its affiliates. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /* * buffer.c: allocate/free network buffers. * * Copyright (c) 2008 Eliot Dresselhaus * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /** * @file * * Allocate/free network buffers. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include STATIC_ASSERT (VLIB_BUFFER_PRE_DATA_SIZE == RTE_PKTMBUF_HEADROOM, "VLIB_BUFFER_PRE_DATA_SIZE must be equal to RTE_PKTMBUF_HEADROOM"); static struct rte_mbuf ***mbuf_pending_free_list = 0; static_always_inline void dpdk_rte_pktmbuf_free (vlib_main_t * vm, vlib_buffer_t * b) { vlib_buffer_t *hb = b; struct rte_mbuf *mb; u32 next, flags; mb = rte_mbuf_from_vlib_buffer (hb); static struct rte_mempool *last_pool = 0; static u8 last_buffer_pool_index; next: flags = b->flags; next = b->next_buffer; mb = rte_mbuf_from_vlib_buffer (b); if (PREDICT_FALSE (b->n_add_refs)) { rte_mbuf_refcnt_update (mb, b->n_add_refs); b->n_add_refs = 0; } mb = rte_pktmbuf_prefree_seg (mb); if (mb) { if (mb->pool != last_pool) { last_pool = mb->pool; dpdk_mempool_private_t *privp = rte_mempool_get_priv (last_pool); last_buffer_pool_index = privp->buffer_pool_index; vec_validate_aligned (mbuf_pending_free_list, last_buffer_pool_index, CLIB_CACHE_LINE_BYTES); } vec_add1 (mbuf_pending_free_list[last_buffer_pool_index], mb); } if (flags & VLIB_BUFFER_NEXT_PRESENT) { b = vlib_get_buffer (vm, next); goto next; } } #ifndef CLIB_MULTIARCH_VARIANT static void del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f) { u32 i; vlib_buffer_t *b; for (i = 0; i < vec_len (f->buffers); i++) { b = vlib_get_buffer (vm, f->buffers[i]); dpdk_rte_pktmbuf_free (vm, b); } vec_free (f->name); vec_free (f->buffers); } /* Add buffer free list. */ static void dpdk_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index) { vlib_buffer_main_t *bm = vm->buffer_main; vlib_buffer_free_list_t *f; u32 merge_index; int i; ASSERT (vlib_get_thread_index () == 0); f = vlib_buffer_get_free_list (vm, free_list_index); merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes); if (merge_index != ~0 && merge_index != free_list_index) { vlib_buffer_merge_free_lists (pool_elt_at_index (bm->buffer_free_list_pool, merge_index), f); } del_free_list (vm, f); /* Poison it. */ memset (f, 0xab, sizeof (f[0])); pool_put (bm->buffer_free_list_pool, f); for (i = 1; i < vec_len (vlib_mains); i++) { bm = vlib_mains[i]->buffer_main; f = vlib_buffer_get_free_list (vlib_mains[i], free_list_index);; memset (f, 0xab, sizeof (f[0])); pool_put (bm->buffer_free_list_pool, f); } } #endif /* Make sure free list has at least given number of free buffers. */ static uword fill_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * fl, uword min_free_buffers) { dpdk_main_t *dm = &dpdk_main; vlib_buffer_t *b0, *b1, *b2, *b3; int n, i; u32 bi0, bi1, bi2, bi3; unsigned socket_id = rte_socket_id (); struct rte_mempool *rmp = dm->pktmbuf_pools[socket_id]; dpdk_mempool_private_t *privp = rte_mempool_get_priv (rmp); struct rte_mbuf *mb0, *mb1, *mb2, *mb3; vlib_buffer_t bt; /* Too early? */ if (PREDICT_FALSE (rmp == 0)) return 0; /* Already have enough free buffers on free list? */ n = min_free_buffers - vec_len (fl->buffers); if (n <= 0) return min_free_buffers; /* Always allocate round number of buffers. */ n = round_pow2 (n, CLIB_CACHE_LINE_BYTES / sizeof (u32)); /* Always allocate new buffers in reasonably large sized chunks. */ n = clib_max (n, fl->min_n_buffers_each_physmem_alloc); vec_validate_aligned (vm->mbuf_alloc_list, n - 1, CLIB_CACHE_LINE_BYTES); if (rte_mempool_get_bulk (rmp, vm->mbuf_alloc_list, n) < 0) return 0; memset (&bt, 0, sizeof (vlib_buffer_t)); vlib_buffer_init_for_free_list (&bt, fl); bt.buffer_pool_index = privp->buffer_pool_index; _vec_len (vm->mbuf_alloc_list) = n; i = 0; int f = vec_len (fl->buffers); vec_resize_aligned (fl->buffers, n, CLIB_CACHE_LINE_BYTES); while (i < (n - 7)) { vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (vm->mbuf_alloc_list[i + 4]), STORE); vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (vm->mbuf_alloc_list[i + 5]), STORE); vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (vm->mbuf_alloc_list[i + 6]), STORE); vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf (vm->mbuf_alloc_list[i + 7]), STORE); mb0 = vm->mbuf_alloc_list[i]; mb1 = vm->mbuf_alloc_list[i + 1]; mb2 = vm->mbuf_alloc_list[i + 2]; mb3 = vm->mbuf_alloc_list[i + 3]; b0 = vlib_buffer_from_rte_mbuf (mb0); b1 = vlib_buffer_from_rte_mbuf (mb1); b2 = vlib_buffer_from_rte_mbuf (mb2); b3 = vlib_buffer_from_rte_mbuf (mb3); bi0 = vlib_get_buffer_index (vm, b0); bi1 = vlib_get_buffer_index (vm, b1); bi2 = vlib_get_buffer_index (vm, b2); bi3 = vlib_get_buffer_index (vm, b3); fl->buffers[f++] = bi0; fl->buffers[f++] = bi1; fl->buffers[f++] = bi2; fl->buffers[f++] = bi3; clib_memcpy64_x4 (b0, b1, b2, b3, &bt); if (fl->buffer_init_function) { fl->buffer_init_function (vm, fl, &bi0, 1); fl->buffer_init_function (vm, fl, &bi1, 1); fl->buffer_init_function (vm, fl, &bi2, 1); fl->buffer_init_function (vm, fl, &bi3, 1); } i += 4; } while (i < n) { mb0 = vm->mbuf_alloc_list[i]; b0 = vlib_buffer_from_rte_mbuf (mb0); bi0 = vlib_get_buffer_index (vm, b0); fl->buffers[f++] = bi0; clib_memcpy (b0, &bt, sizeof (vlib_buffer_t)); if (fl->buffer_init_function) fl->buffer_init_function (vm, fl, &bi0, 1); i++; } fl->n_alloc += n; return n; } static u32 alloc_from_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * free_list, u32 * alloc_buffers, u32 n_alloc_buffers) { u32 *dst, *src; uword len, n_filled; dst = alloc_buffers; n_filled = fill_free_list (vm, free_list, n_alloc_buffers); if (n_filled == 0) return 0; len = vec_len (free_list->buffers); ASSERT (len >= n_alloc_buffers); src = free_list->buffers + len - n_alloc_buffers; clib_memcpy (dst, src, n_alloc_buffers * sizeof (u32)); _vec_len (free_list->buffers) -= n_alloc_buffers; return n_alloc_buffers; } /* Allocate a given number of buffers into given array. Returns number actually allocated which will be either zero or number requested. */ u32 CLIB_MULTIARCH_FN (dpdk_buffer_alloc) (vlib_main_t * vm, u32 * buffers, u32 n_buffers) { vlib_buffer_main_t *bm = vm->buffer_main; return alloc_from_free_list (vm, pool_elt_at_index (bm->buffer_free_list_pool, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX), buffers, n_buffers); } u32 CLIB_MULTIARCH_FN (dpdk_buffer_alloc_from_free_list) (vlib_main_t * vm, u32 * buffers, u32 n_buffers, u32 free_list_index) { vlib_buffer_main_t *bm = vm->buffer_main; vlib_buffer_free_list_t *f; f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index); return alloc_from_free_list (vm, f, buffers, n_buffers); } static_always_inline void dpdk_prefetch_buffer_by_index (vlib_main_t * vm, u32 bi) { vlib_buffer_t *b; struct rte_mbuf *mb; b = vlib_get_buffer (vm, bi); mb = rte_mbuf_from_vlib_buffer (b); CLIB_PREFETCH (mb, CLIB_CACHE_LINE_BYTES, STORE); CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, LOAD); } static_always_inline void recycle_or_free (vlib_main_t * vm, vlib_buffer_main_t * bm, u32 bi, vlib_buffer_t * b) { vlib_buffer_free_list_t *fl; u32 fi; fl = vlib_buffer_get_buffer_free_list (vm, b, &fi); /* The only current use of this callback: multicast recycle */ if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0)) { int j; vlib_buffer_add_to_free_list (vm, fl, bi, (b->flags & VLIB_BUFFER_RECYCLE) == 0); for (j = 0; j < vec_len (bm->announce_list); j++) { if (fl == bm->announce_list[j]) goto already_announced; } vec_add1 (bm->announce_list, fl); already_announced: ; } else { if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0)) dpdk_rte_pktmbuf_free (vm, b); } } static_always_inline void vlib_buffer_free_inline (vlib_main_t * vm, u32 * buffers, u32 n_buffers, u32 follow_buffer_next) { vlib_buffer_main_t *bm = vm->buffer_main; vlib_buffer_t *b0, *b1, *b2, *b3; int i = 0; u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers, u32 follow_buffer_next); cb = bm->buffer_free_callback; if (PREDICT_FALSE (cb != 0)) n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next); if (!n_buffers) return; while (i + 7 < n_buffers) { dpdk_prefetch_buffer_by_index (vm, buffers[i + 4]); dpdk_prefetch_buffer_by_index (vm, buffers[i + 5]); dpdk_prefetch_buffer_by_index (vm, buffers[i + 6]); dpdk_prefetch_buffer_by_index (vm, buffers[i + 7]); b0 = vlib_get_buffer (vm, buffers[i]); b1 = vlib_get_buffer (vm, buffers[i + 1]); b2 = vlib_get_buffer (vm, buffers[i + 2]); b3 = vlib_get_buffer (vm, buffers[i + 3]); VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0); VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1); VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b2); VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b3); recycle_or_free (vm, bm, buffers[i], b0); recycle_or_free (vm, bm, buffers[i + 1], b1); recycle_or_free (vm, bm, buffers[i + 2], b2); recycle_or_free (vm, bm, buffers[i + 3], b3); i += 4; } while (i < n_buffers) { b0 = vlib_get_buffer (vm, buffers[i]); VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b); recycle_or_free (vm, bm, buffers[i], b0); i++; } if (vec_len (bm->announce_list)) { vlib_buffer_free_list_t *fl; for (i = 0; i < vec_len (bm->announce_list); i++) { fl = bm->announce_list[i]; fl->buffers_added_to_freelist_function (vm, fl); } _vec_len (bm->announce_list) = 0; } vec_foreach_index (i, mbuf_pending_free_list) { int len = vec_len (mbuf_pending_free_list[i]); if (len) { rte_mempool_put_bulk (mbuf_pending_free_list[i][len - 1]->pool, (void *) mbuf_pending_free_list[i], len); vec_reset_length (mbuf_pending_free_list[i]); } } } void CLIB_MULTIARCH_FN (dpdk_buffer_free) (vlib_main_t * vm, u32 * buffers, u32 n_buffers) { vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */ 1); } void CLIB_MULTIARCH_FN (dpdk_buffer_free_no_next) (vlib_main_t * vm, u32 * buffers, u32 n_buffers) { vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */ 0); } #ifndef CLIB_MULTIARCH_VARIANT static void dpdk_packet_template_init (vlib_main_t * vm, void *vt, void *packet_data, uword n_packet_data_bytes, uword min_n_buffers_each_physmem_alloc, u8 * name) { vlib_packet_template_t *t = (vlib_packet_template_t *) vt; vlib_worker_thread_barrier_sync (vm); memset (t, 0, sizeof (t[0])); vec_add (t->packet_data, packet_data, n_packet_data_bytes); vlib_worker_thread_barrier_release (vm); } clib_error_t * dpdk_pool_create (vlib_main_t * vm, u8 * pool_name, u32 elt_size, u32 num_elts, u32 pool_priv_size, u16 cache_size, u8 numa, struct rte_mempool **_mp, vlib_physmem_region_index_t * pri) { struct rte_mempool *mp; vlib_physmem_region_t *pr; clib_error_t *error = 0; u32 size, obj_size; i32 ret; obj_size = rte_mempool_calc_obj_size (elt_size, 0, 0); #if RTE_VERSION < RTE_VERSION_NUM(17, 11, 0, 0) size = rte_mempool_xmem_size (num_elts, obj_size, 21); #else size = rte_mempool_xmem_size (num_elts, obj_size, 21, 0); #endif error = vlib_physmem_region_alloc (vm, (i8 *) pool_name, size, numa, 0, pri); if (error) return error; pr = vlib_physmem_get_region (vm, pri[0]); mp = rte_mempool_create_empty ((i8 *) pool_name, num_elts, elt_size, 512, pool_priv_size, numa, 0); if (!mp) return clib_error_return (0, "failed to create %s", pool_name); rte_mempool_set_ops_byname (mp, RTE_MBUF_DEFAULT_MEMPOOL_OPS, NULL); #if RTE_VERSION < RTE_VERSION_NUM(17, 11, 0, 0) ret = rte_mempool_populate_phys_tab (mp, pr->mem, pr->page_table, pr->n_pages, pr->log2_page_size, NULL, NULL); #else ret = rte_mempool_populate_iova_tab (mp, pr->mem, pr->page_table, pr->n_pages, pr->log2_page_size, NULL, NULL); #endif if (ret != (i32) mp->size) { rte_mempool_free (mp); return clib_error_return (0, "failed to populate %s", pool_name); } _mp[0] = mp; return 0; } clib_error_t * dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs, unsigned socket_id) { dpdk_main_t *dm = &dpdk_main; struct rte_mempool *rmp; dpdk_mempool_private_t priv; vlib_physmem_region_index_t pri; clib_error_t *error = 0; u8 *pool_name; u32 elt_size, i; vec_validate_aligned (dm->pktmbuf_pools, socket_id, CLIB_CACHE_LINE_BYTES); /* pool already exists, nothing to do */ if (dm->pktmbuf_pools[socket_id]) return 0; pool_name = format (0, "dpdk_mbuf_pool_socket%u%c", socket_id, 0); elt_size = sizeof (struct rte_mbuf) + VLIB_BUFFER_HDR_SIZE /* priv size */ + VLIB_BUFFER_PRE_DATA_SIZE + VLIB_BUFFER_DATA_SIZE; /*data room size */ error = dpdk_pool_create (vm, pool_name, elt_size, num_mbufs, sizeof (dpdk_mempool_private_t), 512, socket_id, &rmp, &pri); vec_free (pool_name); if (!error) { priv.mbp_priv.mbuf_data_room_size = VLIB_BUFFER_PRE_DATA_SIZE + VLIB_BUFFER_DATA_SIZE; priv.mbp_priv.mbuf_priv_size = VLIB_BUFFER_HDR_SIZE; /* call the mempool priv initializer */ rte_pktmbuf_pool_init (rmp, &priv); /* call the object initializers */ rte_mempool_obj_iter (rmp, rte_pktmbuf_init, 0); dpdk_mempool_private_t *privp = rte_mempool_get_priv (rmp); privp->buffer_pool_index = vlib_buffer_add_physmem_region (vm, pri); dm->pktmbuf_pools[socket_id] = rmp; return 0; } clib_error_report (error); /* no usable pool for this socket, try to use pool from another one */ for (i = 0; i < vec_len (dm->pktmbuf_pools); i++) { if (dm->pktmbuf_pools[i]) { clib_warning ("WARNING: Failed to allocate mempool for CPU socket " "%u. Threads running on socket %u will use socket %u " "mempool.", socket_id, socket_id, i); dm->pktmbuf_pools[socket_id] = dm->pktmbuf_pools[i]; return 0; } } return clib_error_return (0, "failed to allocate mempool on socket %u", socket_id); } #if CLIB_DEBUG > 0 u32 *vlib_buffer_state_validation_lock; uword *vlib_buffer_state_validation_hash; void *vlib_buffer_state_heap; static clib_error_t * buffer_state_validation_init (vlib_main_t * vm) { void *oldheap; vlib_buffer_state_heap = mheap_alloc (0, 10 << 20); oldheap = clib_mem_set_heap (vlib_buffer_state_heap); vlib_buffer_state_validation_hash = hash_create (0, sizeof (uword)); vec_validate_aligned (vlib_buffer_state_validation_lock, 0, CLIB_CACHE_LINE_BYTES); clib_mem_set_heap (oldheap); return 0; } VLIB_INIT_FUNCTION (buffer_state_validation_init); #endif #if CLI_DEBUG struct dpdk_validate_buf_result { u32 invalid; u32 uninitialized; }; #define DPDK_TRAJECTORY_POISON 31 static void dpdk_buffer_validate_trajectory (struct rte_mempool *mp, void *opaque, void *obj, unsigned obj_idx) { vlib_buffer_t *b; struct dpdk_validate_buf_result *counter = opaque; b = vlib_buffer_from_rte_mbuf ((struct rte_mbuf *) obj); if (b->pre_data[0] != 0) { if (b->pre_data[0] == DPDK_TRAJECTORY_POISON) counter->uninitialized++; else counter->invalid++; } } int dpdk_buffer_validate_trajectory_all (u32 * uninitialized) { dpdk_main_t *dm = &dpdk_main; struct dpdk_validate_buf_result counter = { 0 }; int i; for (i = 0; i < vec_len (dm->pktmbuf_pools); i++) rte_mempool_obj_iter (dm->pktmbuf_pools[i], dpdk_buffer_validate_trajectory, &counter); if (uninitialized) *uninitialized = counter.uninitialized; return counter.invalid; } static void dpdk_buffer_poison_trajectory (struct rte_mempool *mp, void *opaque, void *obj, unsigned obj_idx) { vlib_buffer_t *b; b = vlib_buffer_from_rte_mbuf ((struct rte_mbuf *) obj); b->pre_data[0] = DPDK_TRAJECTORY_POISON; } void dpdk_buffer_poison_trajectory_all (void) { dpdk_main_t *dm = &dpdk_main; int i; for (i = 0; i < vec_len (dm->pktmbuf_pools); i++) rte_mempool_obj_iter (dm->pktmbuf_pools[i], dpdk_buffer_poison_trajectory, 0); } #endif /* *INDENT-OFF* */ VLIB_BUFFER_REGISTER_CALLBACKS (dpdk, static) = { .vlib_buffer_alloc_cb = &dpdk_buffer_alloc, .vlib_buffer_alloc_from_free_list_cb = &dpdk_buffer_alloc_from_free_list, .vlib_buffer_free_cb = &dpdk_buffer_free, .vlib_buffer_free_no_next_cb = &dpdk_buffer_free_no_next, .vlib_packet_template_init_cb = &dpdk_packet_template_init, .vlib_buffer_delete_free_list_cb = &dpdk_buffer_delete_free_list, }; /* *INDENT-ON* */ #if __x86_64__ vlib_buffer_alloc_cb_t __clib_weak dpdk_buffer_alloc_avx512; vlib_buffer_alloc_cb_t __clib_weak dpdk_buffer_alloc_avx2; vlib_buffer_alloc_from_free_list_cb_t __clib_weak dpdk_buffer_alloc_from_free_list_avx512; vlib_buffer_alloc_from_free_list_cb_t __clib_weak dpdk_buffer_alloc_from_free_list_avx2; vlib_buffer_free_cb_t __clib_weak dpdk_buffer_free_avx512; vlib_buffer_free_cb_t __clib_weak dpdk_buffer_free_avx2; vlib_buffer_free_no_next_cb_t __clib_weak dpdk_buffer_free_no_next_avx512; vlib_buffer_free_no_next_cb_t __clib_weak dpdk_buffer_free_no_next_avx2; static void __clib_constructor dpdk_input_multiarch_select (void) { vlib_buffer_callbacks_t *cb = &__dpdk_buffer_callbacks; if (dpdk_buffer_alloc_avx512 && clib_cpu_supports_avx512f ()) { cb->vlib_buffer_alloc_cb = dpdk_buffer_alloc_avx512; cb->vlib_buffer_alloc_from_free_list_cb = dpdk_buffer_alloc_from_free_list_avx512; cb->vlib_buffer_free_cb = dpdk_buffer_free_avx512; cb->vlib_buffer_free_no_next_cb = dpdk_buffer_free_no_next_avx512; } else if (dpdk_buffer_alloc_avx2 && clib_cpu_supports_avx2 ()) { cb->vlib_buffer_alloc_cb = dpdk_buffer_alloc_avx2; cb->vlib_buffer_alloc_from_free_list_cb = dpdk_buffer_alloc_from_free_list_avx2; cb->vlib_buffer_free_cb = dpdk_buffer_free_avx2; cb->vlib_buffer_free_no_next_cb = dpdk_buffer_free_no_next_avx2; } } #endif #endif /** @endcond */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */