2 * Copyright (c) 2015 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.
15 #include <vnet/vnet.h>
16 #include <vppinfra/vec.h>
17 #include <vppinfra/format.h>
18 #include <vlib/unix/cj.h>
21 #include <vnet/ethernet/ethernet.h>
22 #include <dpdk/device/dpdk.h>
24 #include <dpdk/device/dpdk_priv.h>
25 #include <vppinfra/error.h>
27 #define foreach_dpdk_tx_func_error \
28 _(BAD_RETVAL, "DPDK tx function returned an error") \
29 _(PKT_DROP, "Tx packet drops (dpdk tx failure)")
33 #define _(f,s) DPDK_TX_FUNC_ERROR_##f,
34 foreach_dpdk_tx_func_error
37 } dpdk_tx_func_error_t;
39 static char *dpdk_tx_func_error_strings[] = {
41 foreach_dpdk_tx_func_error
46 dpdk_set_mac_address (vnet_hw_interface_t * hi,
47 const u8 * old_address, const u8 * address)
50 dpdk_main_t *dm = &dpdk_main;
51 dpdk_device_t *xd = vec_elt_at_index (dm->devices, hi->dev_instance);
53 error = rte_eth_dev_default_mac_addr_set (xd->port_id,
54 (struct ether_addr *) address);
58 return clib_error_return (0, "mac address set failed: %d", error);
62 vec_reset_length (xd->default_mac_address);
63 vec_add (xd->default_mac_address, address, sizeof (address));
69 dpdk_tx_trace_buffer (dpdk_main_t * dm, vlib_node_runtime_t * node,
70 dpdk_device_t * xd, u16 queue_id,
71 vlib_buffer_t * buffer)
73 vlib_main_t *vm = vlib_get_main ();
77 mb = rte_mbuf_from_vlib_buffer (buffer);
79 t0 = vlib_add_trace (vm, node, buffer, sizeof (t0[0]));
80 t0->queue_index = queue_id;
81 t0->device_index = xd->device_index;
82 t0->buffer_index = vlib_get_buffer_index (vm, buffer);
83 clib_memcpy_fast (&t0->mb, mb, sizeof (t0->mb));
84 clib_memcpy_fast (&t0->buffer, buffer,
85 sizeof (buffer[0]) - sizeof (buffer->pre_data));
86 clib_memcpy_fast (t0->buffer.pre_data, buffer->data + buffer->current_data,
87 sizeof (t0->buffer.pre_data));
88 clib_memcpy_fast (&t0->data, mb->buf_addr + mb->data_off,
92 static_always_inline void
93 dpdk_validate_rte_mbuf (vlib_main_t * vm, vlib_buffer_t * b,
96 struct rte_mbuf *mb, *first_mb, *last_mb;
98 /* buffer is coming from non-dpdk source so we need to init
100 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_EXT_HDR_VALID) == 0))
102 vlib_buffer_t *b2 = b;
103 last_mb = mb = rte_mbuf_from_vlib_buffer (b2);
104 rte_pktmbuf_reset (mb);
105 while (maybe_multiseg && (b2->flags & VLIB_BUFFER_NEXT_PRESENT))
107 b2 = vlib_get_buffer (vm, b2->next_buffer);
108 mb = rte_mbuf_from_vlib_buffer (b2);
109 rte_pktmbuf_reset (mb);
113 last_mb = first_mb = mb = rte_mbuf_from_vlib_buffer (b);
114 first_mb->nb_segs = 1;
115 mb->data_len = b->current_length;
116 mb->pkt_len = maybe_multiseg ? vlib_buffer_length_in_chain (vm, b) :
118 mb->data_off = VLIB_BUFFER_PRE_DATA_SIZE + b->current_data;
120 while (maybe_multiseg && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
122 b = vlib_get_buffer (vm, b->next_buffer);
123 mb = rte_mbuf_from_vlib_buffer (b);
126 mb->data_len = b->current_length;
127 mb->pkt_len = b->current_length;
128 mb->data_off = VLIB_BUFFER_PRE_DATA_SIZE + b->current_data;
130 if (PREDICT_FALSE (b->n_add_refs))
132 rte_mbuf_refcnt_update (mb, b->n_add_refs);
139 * This function calls the dpdk's tx_burst function to transmit the packets.
140 * It manages a lock per-device if the device does not
141 * support multiple queues. It returns the number of packets untransmitted
142 * If all packets are transmitted (the normal case), the function returns 0.
145 u32 tx_burst_vector_internal (vlib_main_t * vm,
147 struct rte_mbuf **mb, u32 n_left)
149 dpdk_main_t *dm = &dpdk_main;
155 queue_id = vm->thread_index;
160 * This device only supports one TX queue,
161 * and we're running multi-threaded...
163 if (PREDICT_FALSE (xd->lockp != 0))
165 queue_id = queue_id % xd->tx_q_used;
166 while (clib_atomic_test_and_set (xd->lockp[queue_id]))
168 queue_id = (queue_id + 1) % xd->tx_q_used;
171 if (PREDICT_FALSE (xd->flags & DPDK_DEVICE_FLAG_HQOS)) /* HQoS ON */
173 /* no wrap, transmit in one burst */
174 dpdk_device_hqos_per_worker_thread_t *hqos =
175 &xd->hqos_wt[vm->thread_index];
177 ASSERT (hqos->swq != NULL);
179 dpdk_hqos_metadata_set (hqos, mb, n_left);
180 n_sent = rte_ring_sp_enqueue_burst (hqos->swq, (void **) mb,
183 else if (PREDICT_TRUE (xd->flags & DPDK_DEVICE_FLAG_PMD))
185 /* no wrap, transmit in one burst */
186 n_sent = rte_eth_tx_burst (xd->port_id, queue_id, mb, n_left);
194 if (PREDICT_FALSE (xd->lockp != 0))
195 clib_atomic_release (xd->lockp[queue_id]);
197 if (PREDICT_FALSE (n_sent < 0))
199 // emit non-fatal message, bump counter
200 vnet_main_t *vnm = dm->vnet_main;
201 vnet_interface_main_t *im = &vnm->interface_main;
204 node_index = vec_elt_at_index (im->hw_interfaces,
205 xd->hw_if_index)->tx_node_index;
207 vlib_error_count (vm, node_index, DPDK_TX_FUNC_ERROR_BAD_RETVAL, 1);
208 clib_warning ("rte_eth_tx_burst[%d]: error %d",
209 xd->port_id, n_sent);
210 return n_left; // untransmitted packets
215 while (n_sent && n_left && (n_retry > 0));
220 static_always_inline void
221 dpdk_prefetch_buffer (vlib_main_t * vm, struct rte_mbuf *mb)
223 vlib_buffer_t *b = vlib_buffer_from_rte_mbuf (mb);
224 CLIB_PREFETCH (mb, 2 * CLIB_CACHE_LINE_BYTES, STORE);
225 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, LOAD);
228 static_always_inline void
229 dpdk_buffer_tx_offload (dpdk_device_t * xd, vlib_buffer_t * b,
232 u32 ip_cksum = b->flags & VNET_BUFFER_F_OFFLOAD_IP_CKSUM;
233 u32 tcp_cksum = b->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
234 u32 udp_cksum = b->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
235 int is_ip4 = b->flags & VNET_BUFFER_F_IS_IP4;
238 /* Is there any work for us? */
239 if (PREDICT_TRUE ((ip_cksum | tcp_cksum | udp_cksum) == 0))
242 mb->l2_len = vnet_buffer (b)->l3_hdr_offset - b->current_data;
243 mb->l3_len = vnet_buffer (b)->l4_hdr_offset -
244 vnet_buffer (b)->l3_hdr_offset;
245 mb->outer_l3_len = 0;
246 mb->outer_l2_len = 0;
247 ol_flags = is_ip4 ? PKT_TX_IPV4 : PKT_TX_IPV6;
248 ol_flags |= ip_cksum ? PKT_TX_IP_CKSUM : 0;
249 ol_flags |= tcp_cksum ? PKT_TX_TCP_CKSUM : 0;
250 ol_flags |= udp_cksum ? PKT_TX_UDP_CKSUM : 0;
251 mb->ol_flags |= ol_flags;
253 /* we are trying to help compiler here by using local ol_flags with known
254 state of all flags */
255 if (xd->flags & DPDK_DEVICE_FLAG_INTEL_PHDR_CKSUM)
256 rte_net_intel_cksum_flags_prepare (mb, ol_flags);
260 * Transmits the packets on the frame to the interface associated with the
261 * node. It first copies packets on the frame to a per-thread arrays
262 * containing the rte_mbuf pointers.
264 VNET_DEVICE_CLASS_TX_FN (dpdk_device_class) (vlib_main_t * vm,
265 vlib_node_runtime_t * node,
268 dpdk_main_t *dm = &dpdk_main;
269 vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
270 dpdk_device_t *xd = vec_elt_at_index (dm->devices, rd->dev_instance);
271 u32 n_packets = f->n_vectors;
274 u32 thread_index = vm->thread_index;
275 int queue_id = thread_index;
276 u32 tx_pkts = 0, all_or_flags = 0;
277 dpdk_per_thread_data_t *ptd = vec_elt_at_index (dm->per_thread_data,
279 struct rte_mbuf **mb;
282 from = vlib_frame_vector_args (f);
284 ASSERT (n_packets <= VLIB_FRAME_SIZE);
286 /* TX PCAP tracing */
287 if (PREDICT_FALSE (dm->pcap[VLIB_TX].pcap_enable))
293 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
294 if (dm->pcap[VLIB_TX].pcap_sw_if_index == 0 ||
295 dm->pcap[VLIB_TX].pcap_sw_if_index
296 == vnet_buffer (b0)->sw_if_index[VLIB_TX])
297 pcap_add_buffer (&dm->pcap[VLIB_TX].pcap_main, vm, bi0, 512);
303 /* calculate rte_mbuf pointers out of buffer indices */
304 vlib_get_buffers_with_offset (vm, vlib_frame_vector_args (f),
305 (void **) ptd->mbufs, n_packets,
306 -(i32) sizeof (struct rte_mbuf));
308 from = vlib_frame_vector_args (f);
316 dpdk_prefetch_buffer (vm, mb[4]);
317 dpdk_prefetch_buffer (vm, mb[5]);
318 dpdk_prefetch_buffer (vm, mb[6]);
319 dpdk_prefetch_buffer (vm, mb[7]);
321 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
322 b[1] = vlib_buffer_from_rte_mbuf (mb[1]);
323 b[2] = vlib_buffer_from_rte_mbuf (mb[2]);
324 b[3] = vlib_buffer_from_rte_mbuf (mb[3]);
326 or_flags = b[0]->flags | b[1]->flags | b[2]->flags | b[3]->flags;
327 all_or_flags |= or_flags;
329 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
330 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[1]);
331 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[2]);
332 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[3]);
334 if (or_flags & VLIB_BUFFER_NEXT_PRESENT)
336 dpdk_validate_rte_mbuf (vm, b[0], 1);
337 dpdk_validate_rte_mbuf (vm, b[1], 1);
338 dpdk_validate_rte_mbuf (vm, b[2], 1);
339 dpdk_validate_rte_mbuf (vm, b[3], 1);
343 dpdk_validate_rte_mbuf (vm, b[0], 0);
344 dpdk_validate_rte_mbuf (vm, b[1], 0);
345 dpdk_validate_rte_mbuf (vm, b[2], 0);
346 dpdk_validate_rte_mbuf (vm, b[3], 0);
349 if (PREDICT_FALSE ((xd->flags & DPDK_DEVICE_FLAG_TX_OFFLOAD) &&
351 (VNET_BUFFER_F_OFFLOAD_TCP_CKSUM
352 | VNET_BUFFER_F_OFFLOAD_IP_CKSUM
353 | VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))))
355 dpdk_buffer_tx_offload (xd, b[0], mb[0]);
356 dpdk_buffer_tx_offload (xd, b[1], mb[1]);
357 dpdk_buffer_tx_offload (xd, b[2], mb[2]);
358 dpdk_buffer_tx_offload (xd, b[3], mb[3]);
361 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
363 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
364 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[0]);
365 if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
366 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[1]);
367 if (b[2]->flags & VLIB_BUFFER_IS_TRACED)
368 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[2]);
369 if (b[3]->flags & VLIB_BUFFER_IS_TRACED)
370 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[3]);
378 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
379 all_or_flags |= b[0]->flags;
380 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
382 dpdk_validate_rte_mbuf (vm, b[0], 1);
383 dpdk_buffer_tx_offload (xd, b[0], mb[0]);
385 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
386 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
387 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[0]);
393 /* transmit as many packets as possible */
394 tx_pkts = n_packets = mb - ptd->mbufs;
395 n_left = tx_burst_vector_internal (vm, xd, ptd->mbufs, n_packets);
398 /* If there is no callback then drop any non-transmitted packets */
399 if (PREDICT_FALSE (n_left))
402 vlib_simple_counter_main_t *cm;
403 vnet_main_t *vnm = vnet_get_main ();
405 cm = vec_elt_at_index (vnm->interface_main.sw_if_counters,
406 VNET_INTERFACE_COUNTER_TX_ERROR);
408 vlib_increment_simple_counter (cm, thread_index, xd->sw_if_index,
411 vlib_error_count (vm, node->node_index, DPDK_TX_FUNC_ERROR_PKT_DROP,
415 rte_pktmbuf_free (ptd->mbufs[n_packets - n_left - 1]);
423 dpdk_clear_hw_interface_counters (u32 instance)
425 dpdk_main_t *dm = &dpdk_main;
426 dpdk_device_t *xd = vec_elt_at_index (dm->devices, instance);
429 * Set the "last_cleared_stats" to the current stats, so that
430 * things appear to clear from a display perspective.
432 dpdk_update_counters (xd, vlib_time_now (dm->vlib_main));
434 clib_memcpy_fast (&xd->last_cleared_stats, &xd->stats, sizeof (xd->stats));
435 clib_memcpy_fast (xd->last_cleared_xstats, xd->xstats,
436 vec_len (xd->last_cleared_xstats) *
437 sizeof (xd->last_cleared_xstats[0]));
441 static clib_error_t *
442 dpdk_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
444 vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
445 uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
446 dpdk_main_t *dm = &dpdk_main;
447 dpdk_device_t *xd = vec_elt_at_index (dm->devices, hif->dev_instance);
449 if (xd->flags & DPDK_DEVICE_FLAG_PMD_INIT_FAIL)
450 return clib_error_return (0, "Interface not initialized");
454 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) == 0)
455 dpdk_device_start (xd);
456 xd->flags |= DPDK_DEVICE_FLAG_ADMIN_UP;
457 f64 now = vlib_time_now (dm->vlib_main);
458 dpdk_update_counters (xd, now);
459 dpdk_update_link_state (xd, now);
463 vnet_hw_interface_set_flags (vnm, xd->hw_if_index, 0);
464 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) != 0)
465 dpdk_device_stop (xd);
466 xd->flags &= ~DPDK_DEVICE_FLAG_ADMIN_UP;
469 return /* no error */ 0;
473 * Dynamically redirect all pkts from a specific interface
474 * to the specified node
477 dpdk_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
480 dpdk_main_t *xm = &dpdk_main;
481 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
482 dpdk_device_t *xd = vec_elt_at_index (xm->devices, hw->dev_instance);
484 /* Shut off redirection */
485 if (node_index == ~0)
487 xd->per_interface_next_index = node_index;
491 xd->per_interface_next_index =
492 vlib_node_add_next (xm->vlib_main, dpdk_input_node.index, node_index);
496 static clib_error_t *
497 dpdk_subif_add_del_function (vnet_main_t * vnm,
499 struct vnet_sw_interface_t *st, int is_add)
501 dpdk_main_t *xm = &dpdk_main;
502 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
503 dpdk_device_t *xd = vec_elt_at_index (xm->devices, hw->dev_instance);
504 vnet_sw_interface_t *t = (vnet_sw_interface_t *) st;
506 u32 prev_subifs = xd->num_subifs;
507 clib_error_t *err = 0;
511 else if (xd->num_subifs)
514 if ((xd->flags & DPDK_DEVICE_FLAG_PMD) == 0)
517 /* currently we program VLANS only for IXGBE VF and I40E VF */
518 if ((xd->pmd != VNET_DPDK_PMD_IXGBEVF) && (xd->pmd != VNET_DPDK_PMD_I40EVF))
521 if (t->sub.eth.flags.no_tags == 1)
524 if ((t->sub.eth.flags.one_tag != 1) || (t->sub.eth.flags.exact_match != 1))
526 xd->num_subifs = prev_subifs;
527 err = clib_error_return (0, "unsupported VLAN setup");
531 vlan_offload = rte_eth_dev_get_vlan_offload (xd->port_id);
532 vlan_offload |= ETH_VLAN_FILTER_OFFLOAD;
534 if ((r = rte_eth_dev_set_vlan_offload (xd->port_id, vlan_offload)))
536 xd->num_subifs = prev_subifs;
537 err = clib_error_return (0, "rte_eth_dev_set_vlan_offload[%d]: err %d",
544 rte_eth_dev_vlan_filter (xd->port_id,
545 t->sub.eth.outer_vlan_id, is_add)))
547 xd->num_subifs = prev_subifs;
548 err = clib_error_return (0, "rte_eth_dev_vlan_filter[%d]: err %d",
555 xd->flags |= DPDK_DEVICE_FLAG_HAVE_SUBIF;
557 xd->flags &= ~DPDK_DEVICE_FLAG_HAVE_SUBIF;
563 VNET_DEVICE_CLASS (dpdk_device_class) = {
565 .tx_function_n_errors = DPDK_TX_FUNC_N_ERROR,
566 .tx_function_error_strings = dpdk_tx_func_error_strings,
567 .format_device_name = format_dpdk_device_name,
568 .format_device = format_dpdk_device,
569 .format_tx_trace = format_dpdk_tx_trace,
570 .clear_counters = dpdk_clear_hw_interface_counters,
571 .admin_up_down_function = dpdk_interface_admin_up_down,
572 .subif_add_del_function = dpdk_subif_add_del_function,
573 .rx_redirect_to_node = dpdk_set_interface_next_node,
574 .mac_addr_change_function = dpdk_set_mac_address,
575 .format_flow = format_dpdk_flow,
576 .flow_ops_function = dpdk_flow_ops_fn,
580 #define UP_DOWN_FLAG_EVENT 1
583 admin_up_down_process (vlib_main_t * vm,
584 vlib_node_runtime_t * rt, vlib_frame_t * f)
586 clib_error_t *error = 0;
588 uword *event_data = 0;
594 vlib_process_wait_for_event (vm);
596 event_type = vlib_process_get_events (vm, &event_data);
598 dpdk_main.admin_up_down_in_progress = 1;
602 case UP_DOWN_FLAG_EVENT:
604 if (vec_len (event_data) == 2)
606 sw_if_index = event_data[0];
607 flags = event_data[1];
609 vnet_sw_interface_set_flags (vnet_get_main (), sw_if_index,
611 clib_error_report (error);
617 vec_reset_length (event_data);
619 dpdk_main.admin_up_down_in_progress = 0;
622 return 0; /* or not */
626 VLIB_REGISTER_NODE (admin_up_down_process_node) = {
627 .function = admin_up_down_process,
628 .type = VLIB_NODE_TYPE_PROCESS,
629 .name = "admin-up-down-process",
630 .process_log2_n_stack_bytes = 17, // 256KB
635 * fd.io coding-style-patch-verification: ON
638 * eval: (c-set-style "gnu")