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 (&t0->mb, mb, sizeof (t0->mb));
84 clib_memcpy (&t0->buffer, buffer,
85 sizeof (buffer[0]) - sizeof (buffer->pre_data));
86 clib_memcpy (t0->buffer.pre_data, buffer->data + buffer->current_data,
87 sizeof (t0->buffer.pre_data));
88 clib_memcpy (&t0->data, mb->buf_addr + mb->data_off, sizeof (t0->data));
91 static_always_inline void
92 dpdk_validate_rte_mbuf (vlib_main_t * vm, vlib_buffer_t * b,
95 struct rte_mbuf *mb, *first_mb, *last_mb;
97 /* buffer is coming from non-dpdk source so we need to init
99 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_EXT_HDR_VALID) == 0))
101 vlib_buffer_t *b2 = b;
102 last_mb = mb = rte_mbuf_from_vlib_buffer (b2);
103 rte_pktmbuf_reset (mb);
104 while (maybe_multiseg && (b2->flags & VLIB_BUFFER_NEXT_PRESENT))
106 b2 = vlib_get_buffer (vm, b2->next_buffer);
107 mb = rte_mbuf_from_vlib_buffer (b2);
108 rte_pktmbuf_reset (mb);
112 last_mb = first_mb = mb = rte_mbuf_from_vlib_buffer (b);
113 first_mb->nb_segs = 1;
114 mb->data_len = b->current_length;
115 mb->pkt_len = maybe_multiseg ? vlib_buffer_length_in_chain (vm, b) :
117 mb->data_off = VLIB_BUFFER_PRE_DATA_SIZE + b->current_data;
119 while (maybe_multiseg && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
121 b = vlib_get_buffer (vm, b->next_buffer);
122 mb = rte_mbuf_from_vlib_buffer (b);
125 mb->data_len = b->current_length;
126 mb->pkt_len = b->current_length;
127 mb->data_off = VLIB_BUFFER_PRE_DATA_SIZE + b->current_data;
129 if (PREDICT_FALSE (b->n_add_refs))
131 rte_mbuf_refcnt_update (mb, b->n_add_refs);
138 * This function calls the dpdk's tx_burst function to transmit the packets.
139 * It manages a lock per-device if the device does not
140 * support multiple queues. It returns the number of packets untransmitted
141 * If all packets are transmitted (the normal case), the function returns 0.
144 u32 tx_burst_vector_internal (vlib_main_t * vm,
146 struct rte_mbuf **mb, u32 n_left)
148 dpdk_main_t *dm = &dpdk_main;
154 queue_id = vm->thread_index;
159 * This device only supports one TX queue,
160 * and we're running multi-threaded...
162 if (PREDICT_FALSE (xd->lockp != 0))
164 queue_id = queue_id % xd->tx_q_used;
165 while (__sync_lock_test_and_set (xd->lockp[queue_id], 1))
167 queue_id = (queue_id + 1) % xd->tx_q_used;
170 if (PREDICT_FALSE (xd->flags & DPDK_DEVICE_FLAG_HQOS)) /* HQoS ON */
172 /* no wrap, transmit in one burst */
173 dpdk_device_hqos_per_worker_thread_t *hqos =
174 &xd->hqos_wt[vm->thread_index];
176 ASSERT (hqos->swq != NULL);
178 dpdk_hqos_metadata_set (hqos, mb, n_left);
179 n_sent = rte_ring_sp_enqueue_burst (hqos->swq, (void **) mb,
182 else if (PREDICT_TRUE (xd->flags & DPDK_DEVICE_FLAG_PMD))
184 /* no wrap, transmit in one burst */
185 n_sent = rte_eth_tx_burst (xd->port_id, queue_id, mb, n_left);
193 if (PREDICT_FALSE (xd->lockp != 0))
194 *xd->lockp[queue_id] = 0;
196 if (PREDICT_FALSE (n_sent < 0))
198 // emit non-fatal message, bump counter
199 vnet_main_t *vnm = dm->vnet_main;
200 vnet_interface_main_t *im = &vnm->interface_main;
203 node_index = vec_elt_at_index (im->hw_interfaces,
204 xd->hw_if_index)->tx_node_index;
206 vlib_error_count (vm, node_index, DPDK_TX_FUNC_ERROR_BAD_RETVAL, 1);
207 clib_warning ("rte_eth_tx_burst[%d]: error %d",
208 xd->port_id, n_sent);
209 return n_left; // untransmitted packets
214 while (n_sent && n_left && (n_retry > 0));
219 static_always_inline void
220 dpdk_prefetch_buffer (vlib_main_t * vm, struct rte_mbuf *mb)
222 vlib_buffer_t *b = vlib_buffer_from_rte_mbuf (mb);
223 CLIB_PREFETCH (mb, 2 * CLIB_CACHE_LINE_BYTES, STORE);
224 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, LOAD);
227 static_always_inline void
228 dpdk_buffer_tx_offload (dpdk_device_t * xd, vlib_buffer_t * b,
231 u32 ip_cksum = b->flags & VNET_BUFFER_F_OFFLOAD_IP_CKSUM;
232 u32 tcp_cksum = b->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
233 u32 udp_cksum = b->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
234 int is_ip4 = b->flags & VNET_BUFFER_F_IS_IP4;
237 /* Is there any work for us? */
238 if (PREDICT_TRUE ((ip_cksum | tcp_cksum | udp_cksum) == 0))
241 mb->l2_len = vnet_buffer (b)->l3_hdr_offset - b->current_data;
242 mb->l3_len = vnet_buffer (b)->l4_hdr_offset -
243 vnet_buffer (b)->l3_hdr_offset;
244 mb->outer_l3_len = 0;
245 mb->outer_l2_len = 0;
246 ol_flags = is_ip4 ? PKT_TX_IPV4 : PKT_TX_IPV6;
247 ol_flags |= ip_cksum ? PKT_TX_IP_CKSUM : 0;
248 ol_flags |= tcp_cksum ? PKT_TX_TCP_CKSUM : 0;
249 ol_flags |= udp_cksum ? PKT_TX_UDP_CKSUM : 0;
250 mb->ol_flags |= ol_flags;
252 /* we are trying to help compiler here by using local ol_flags with known
253 state of all flags */
254 if (xd->flags & DPDK_DEVICE_FLAG_INTEL_PHDR_CKSUM)
255 rte_net_intel_cksum_flags_prepare (mb, ol_flags);
259 * Transmits the packets on the frame to the interface associated with the
260 * node. It first copies packets on the frame to a per-thread arrays
261 * containing the rte_mbuf pointers.
263 VNET_DEVICE_CLASS_TX_FN (dpdk_device_class) (vlib_main_t * vm,
264 vlib_node_runtime_t * node,
267 dpdk_main_t *dm = &dpdk_main;
268 vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
269 dpdk_device_t *xd = vec_elt_at_index (dm->devices, rd->dev_instance);
270 u32 n_packets = f->n_vectors;
273 u32 thread_index = vm->thread_index;
274 int queue_id = thread_index;
275 u32 tx_pkts = 0, all_or_flags = 0;
276 dpdk_per_thread_data_t *ptd = vec_elt_at_index (dm->per_thread_data,
278 struct rte_mbuf **mb;
281 from = vlib_frame_vector_args (f);
283 ASSERT (n_packets <= VLIB_FRAME_SIZE);
285 /* TX PCAP tracing */
286 if (PREDICT_FALSE (dm->pcap[VLIB_TX].pcap_enable))
292 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
293 if (dm->pcap[VLIB_TX].pcap_sw_if_index == 0 ||
294 dm->pcap[VLIB_TX].pcap_sw_if_index
295 == vnet_buffer (b0)->sw_if_index[VLIB_TX])
296 pcap_add_buffer (&dm->pcap[VLIB_TX].pcap_main, vm, bi0, 512);
302 /* calculate rte_mbuf pointers out of buffer indices */
303 vlib_get_buffers_with_offset (vm, vlib_frame_vector_args (f),
304 (void **) ptd->mbufs, n_packets,
305 -(i32) sizeof (struct rte_mbuf));
307 from = vlib_frame_vector_args (f);
315 dpdk_prefetch_buffer (vm, mb[4]);
316 dpdk_prefetch_buffer (vm, mb[5]);
317 dpdk_prefetch_buffer (vm, mb[6]);
318 dpdk_prefetch_buffer (vm, mb[7]);
320 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
321 b[1] = vlib_buffer_from_rte_mbuf (mb[1]);
322 b[2] = vlib_buffer_from_rte_mbuf (mb[2]);
323 b[3] = vlib_buffer_from_rte_mbuf (mb[3]);
325 or_flags = b[0]->flags | b[1]->flags | b[2]->flags | b[3]->flags;
326 all_or_flags |= or_flags;
328 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
329 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[1]);
330 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[2]);
331 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[3]);
333 if (or_flags & VLIB_BUFFER_NEXT_PRESENT)
335 dpdk_validate_rte_mbuf (vm, b[0], 1);
336 dpdk_validate_rte_mbuf (vm, b[1], 1);
337 dpdk_validate_rte_mbuf (vm, b[2], 1);
338 dpdk_validate_rte_mbuf (vm, b[3], 1);
342 dpdk_validate_rte_mbuf (vm, b[0], 0);
343 dpdk_validate_rte_mbuf (vm, b[1], 0);
344 dpdk_validate_rte_mbuf (vm, b[2], 0);
345 dpdk_validate_rte_mbuf (vm, b[3], 0);
348 if (PREDICT_FALSE ((xd->flags & DPDK_DEVICE_FLAG_TX_OFFLOAD) &&
350 (VNET_BUFFER_F_OFFLOAD_TCP_CKSUM
351 | VNET_BUFFER_F_OFFLOAD_IP_CKSUM
352 | VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))))
354 dpdk_buffer_tx_offload (xd, b[0], mb[0]);
355 dpdk_buffer_tx_offload (xd, b[1], mb[1]);
356 dpdk_buffer_tx_offload (xd, b[2], mb[2]);
357 dpdk_buffer_tx_offload (xd, b[3], mb[3]);
360 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
362 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
363 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[0]);
364 if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
365 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[1]);
366 if (b[2]->flags & VLIB_BUFFER_IS_TRACED)
367 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[2]);
368 if (b[3]->flags & VLIB_BUFFER_IS_TRACED)
369 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[3]);
377 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
378 all_or_flags |= b[0]->flags;
379 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
381 dpdk_validate_rte_mbuf (vm, b[0], 1);
382 dpdk_buffer_tx_offload (xd, b[0], mb[0]);
384 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
385 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
386 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[0]);
392 /* transmit as many packets as possible */
393 tx_pkts = n_packets = mb - ptd->mbufs;
394 n_left = tx_burst_vector_internal (vm, xd, ptd->mbufs, n_packets);
397 /* If there is no callback then drop any non-transmitted packets */
398 if (PREDICT_FALSE (n_left))
401 vlib_simple_counter_main_t *cm;
402 vnet_main_t *vnm = vnet_get_main ();
404 cm = vec_elt_at_index (vnm->interface_main.sw_if_counters,
405 VNET_INTERFACE_COUNTER_TX_ERROR);
407 vlib_increment_simple_counter (cm, thread_index, xd->sw_if_index,
410 vlib_error_count (vm, node->node_index, DPDK_TX_FUNC_ERROR_PKT_DROP,
414 rte_pktmbuf_free (ptd->mbufs[n_packets - n_left - 1]);
422 dpdk_clear_hw_interface_counters (u32 instance)
424 dpdk_main_t *dm = &dpdk_main;
425 dpdk_device_t *xd = vec_elt_at_index (dm->devices, instance);
428 * Set the "last_cleared_stats" to the current stats, so that
429 * things appear to clear from a display perspective.
431 dpdk_update_counters (xd, vlib_time_now (dm->vlib_main));
433 clib_memcpy (&xd->last_cleared_stats, &xd->stats, sizeof (xd->stats));
434 clib_memcpy (xd->last_cleared_xstats, xd->xstats,
435 vec_len (xd->last_cleared_xstats) *
436 sizeof (xd->last_cleared_xstats[0]));
440 static clib_error_t *
441 dpdk_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
443 vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
444 uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
445 dpdk_main_t *dm = &dpdk_main;
446 dpdk_device_t *xd = vec_elt_at_index (dm->devices, hif->dev_instance);
448 if (xd->flags & DPDK_DEVICE_FLAG_PMD_INIT_FAIL)
449 return clib_error_return (0, "Interface not initialized");
453 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) == 0)
454 dpdk_device_start (xd);
455 xd->flags |= DPDK_DEVICE_FLAG_ADMIN_UP;
456 f64 now = vlib_time_now (dm->vlib_main);
457 dpdk_update_counters (xd, now);
458 dpdk_update_link_state (xd, now);
462 vnet_hw_interface_set_flags (vnm, xd->hw_if_index, 0);
463 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) != 0)
464 dpdk_device_stop (xd);
465 xd->flags &= ~DPDK_DEVICE_FLAG_ADMIN_UP;
468 return /* no error */ 0;
472 * Dynamically redirect all pkts from a specific interface
473 * to the specified node
476 dpdk_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
479 dpdk_main_t *xm = &dpdk_main;
480 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
481 dpdk_device_t *xd = vec_elt_at_index (xm->devices, hw->dev_instance);
483 /* Shut off redirection */
484 if (node_index == ~0)
486 xd->per_interface_next_index = node_index;
490 xd->per_interface_next_index =
491 vlib_node_add_next (xm->vlib_main, dpdk_input_node.index, node_index);
495 static clib_error_t *
496 dpdk_subif_add_del_function (vnet_main_t * vnm,
498 struct vnet_sw_interface_t *st, int is_add)
500 dpdk_main_t *xm = &dpdk_main;
501 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
502 dpdk_device_t *xd = vec_elt_at_index (xm->devices, hw->dev_instance);
503 vnet_sw_interface_t *t = (vnet_sw_interface_t *) st;
505 u32 prev_subifs = xd->num_subifs;
506 clib_error_t *err = 0;
510 else if (xd->num_subifs)
513 if ((xd->flags & DPDK_DEVICE_FLAG_PMD) == 0)
516 /* currently we program VLANS only for IXGBE VF and I40E VF */
517 if ((xd->pmd != VNET_DPDK_PMD_IXGBEVF) && (xd->pmd != VNET_DPDK_PMD_I40EVF))
520 if (t->sub.eth.flags.no_tags == 1)
523 if ((t->sub.eth.flags.one_tag != 1) || (t->sub.eth.flags.exact_match != 1))
525 xd->num_subifs = prev_subifs;
526 err = clib_error_return (0, "unsupported VLAN setup");
530 vlan_offload = rte_eth_dev_get_vlan_offload (xd->port_id);
531 vlan_offload |= ETH_VLAN_FILTER_OFFLOAD;
533 if ((r = rte_eth_dev_set_vlan_offload (xd->port_id, vlan_offload)))
535 xd->num_subifs = prev_subifs;
536 err = clib_error_return (0, "rte_eth_dev_set_vlan_offload[%d]: err %d",
543 rte_eth_dev_vlan_filter (xd->port_id,
544 t->sub.eth.outer_vlan_id, is_add)))
546 xd->num_subifs = prev_subifs;
547 err = clib_error_return (0, "rte_eth_dev_vlan_filter[%d]: err %d",
554 xd->flags |= DPDK_DEVICE_FLAG_HAVE_SUBIF;
556 xd->flags &= ~DPDK_DEVICE_FLAG_HAVE_SUBIF;
562 VNET_DEVICE_CLASS (dpdk_device_class) = {
564 .tx_function_n_errors = DPDK_TX_FUNC_N_ERROR,
565 .tx_function_error_strings = dpdk_tx_func_error_strings,
566 .format_device_name = format_dpdk_device_name,
567 .format_device = format_dpdk_device,
568 .format_tx_trace = format_dpdk_tx_trace,
569 .clear_counters = dpdk_clear_hw_interface_counters,
570 .admin_up_down_function = dpdk_interface_admin_up_down,
571 .subif_add_del_function = dpdk_subif_add_del_function,
572 .rx_redirect_to_node = dpdk_set_interface_next_node,
573 .mac_addr_change_function = dpdk_set_mac_address,
574 .format_flow = format_dpdk_flow,
575 .flow_ops_function = dpdk_flow_ops_fn,
579 #define UP_DOWN_FLAG_EVENT 1
582 admin_up_down_process (vlib_main_t * vm,
583 vlib_node_runtime_t * rt, vlib_frame_t * f)
585 clib_error_t *error = 0;
587 uword *event_data = 0;
593 vlib_process_wait_for_event (vm);
595 event_type = vlib_process_get_events (vm, &event_data);
597 dpdk_main.admin_up_down_in_progress = 1;
601 case UP_DOWN_FLAG_EVENT:
603 if (vec_len (event_data) == 2)
605 sw_if_index = event_data[0];
606 flags = event_data[1];
608 vnet_sw_interface_set_flags (vnet_get_main (), sw_if_index,
610 clib_error_report (error);
616 vec_reset_length (event_data);
618 dpdk_main.admin_up_down_in_progress = 0;
621 return 0; /* or not */
625 VLIB_REGISTER_NODE (admin_up_down_process_node) = {
626 .function = admin_up_down_process,
627 .type = VLIB_NODE_TYPE_PROCESS,
628 .name = "admin-up-down-process",
629 .process_log2_n_stack_bytes = 17, // 256KB
634 * fd.io coding-style-patch-verification: ON
637 * eval: (c-set-style "gnu")