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>
20 #include <vnet/ethernet/ethernet.h>
21 #include <dpdk/buffer.h>
22 #include <dpdk/device/dpdk.h>
23 #include <dpdk/device/dpdk_priv.h>
24 #include <vppinfra/error.h>
26 #define foreach_dpdk_tx_func_error \
27 _(BAD_RETVAL, "DPDK tx function returned an error") \
28 _(PKT_DROP, "Tx packet drops (dpdk tx failure)")
32 #define _(f,s) DPDK_TX_FUNC_ERROR_##f,
33 foreach_dpdk_tx_func_error
36 } dpdk_tx_func_error_t;
38 static char *dpdk_tx_func_error_strings[] = {
40 foreach_dpdk_tx_func_error
45 dpdk_add_del_mac_address (vnet_hw_interface_t * hi,
46 const u8 * address, u8 is_add)
49 dpdk_main_t *dm = &dpdk_main;
50 dpdk_device_t *xd = vec_elt_at_index (dm->devices, hi->dev_instance);
53 error = rte_eth_dev_mac_addr_add (xd->port_id,
54 (struct rte_ether_addr *) address, 0);
56 error = rte_eth_dev_mac_addr_remove (xd->port_id,
57 (struct rte_ether_addr *) address);
61 return clib_error_return (0, "mac address add/del failed: %d", error);
68 dpdk_set_mac_address (vnet_hw_interface_t * hi,
69 const u8 * old_address, const u8 * address)
72 dpdk_main_t *dm = &dpdk_main;
73 dpdk_device_t *xd = vec_elt_at_index (dm->devices, hi->dev_instance);
75 error = rte_eth_dev_default_mac_addr_set (xd->port_id, (void *) address);
79 return clib_error_return (0, "mac address set failed: %d", error);
83 vec_reset_length (xd->default_mac_address);
84 vec_add (xd->default_mac_address, address, sizeof (address));
90 dpdk_tx_trace_buffer (dpdk_main_t * dm, vlib_node_runtime_t * node,
91 dpdk_device_t * xd, u16 queue_id,
92 vlib_buffer_t * buffer)
94 vlib_main_t *vm = vlib_get_main ();
98 mb = rte_mbuf_from_vlib_buffer (buffer);
100 t0 = vlib_add_trace (vm, node, buffer, sizeof (t0[0]));
101 t0->queue_index = queue_id;
102 t0->device_index = xd->device_index;
103 t0->buffer_index = vlib_get_buffer_index (vm, buffer);
104 clib_memcpy_fast (&t0->mb, mb, sizeof (t0->mb));
105 clib_memcpy_fast (&t0->buffer, buffer,
106 sizeof (buffer[0]) - sizeof (buffer->pre_data));
107 clib_memcpy_fast (t0->buffer.pre_data, buffer->data + buffer->current_data,
108 sizeof (t0->buffer.pre_data));
109 clib_memcpy_fast (&t0->data, mb->buf_addr + mb->data_off,
113 static_always_inline void
114 dpdk_validate_rte_mbuf (vlib_main_t * vm, vlib_buffer_t * b,
117 struct rte_mbuf *mb, *first_mb, *last_mb;
118 last_mb = first_mb = mb = rte_mbuf_from_vlib_buffer (b);
120 /* buffer is coming from non-dpdk source so we need to init
122 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_EXT_HDR_VALID) == 0))
123 rte_pktmbuf_reset (mb);
125 first_mb->nb_segs = 1;
126 mb->data_len = b->current_length;
127 mb->pkt_len = maybe_multiseg ? vlib_buffer_length_in_chain (vm, b) :
129 mb->data_off = VLIB_BUFFER_PRE_DATA_SIZE + b->current_data;
131 while (maybe_multiseg && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
133 b = vlib_get_buffer (vm, b->next_buffer);
134 mb = rte_mbuf_from_vlib_buffer (b);
135 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_EXT_HDR_VALID) == 0))
136 rte_pktmbuf_reset (mb);
139 mb->data_len = b->current_length;
140 mb->pkt_len = b->current_length;
141 mb->data_off = VLIB_BUFFER_PRE_DATA_SIZE + b->current_data;
143 if (PREDICT_FALSE (b->ref_count > 1))
145 dpdk_no_cache_mempool_by_buffer_pool_index[b->buffer_pool_index];
150 * This function calls the dpdk's tx_burst function to transmit the packets.
151 * It manages a lock per-device if the device does not
152 * support multiple queues. It returns the number of packets untransmitted
153 * If all packets are transmitted (the normal case), the function returns 0.
156 u32 tx_burst_vector_internal (vlib_main_t * vm,
158 struct rte_mbuf **mb, u32 n_left)
160 dpdk_main_t *dm = &dpdk_main;
166 queue_id = vm->thread_index;
171 * This device only supports one TX queue,
172 * and we're running multi-threaded...
174 if (PREDICT_FALSE (xd->lockp != 0))
176 queue_id = queue_id % xd->tx_q_used;
177 while (clib_atomic_test_and_set (xd->lockp[queue_id]))
179 queue_id = (queue_id + 1) % xd->tx_q_used;
182 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);
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, sizeof (struct rte_mbuf), 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;
236 u32 tso = b->flags & VNET_BUFFER_F_GSO;
239 /* Is there any work for us? */
240 if (PREDICT_TRUE ((ip_cksum | tcp_cksum | udp_cksum | tso) == 0))
243 mb->l2_len = vnet_buffer (b)->l3_hdr_offset - b->current_data;
244 mb->l3_len = vnet_buffer (b)->l4_hdr_offset -
245 vnet_buffer (b)->l3_hdr_offset;
246 mb->outer_l3_len = 0;
247 mb->outer_l2_len = 0;
248 ol_flags = is_ip4 ? PKT_TX_IPV4 : PKT_TX_IPV6;
249 ol_flags |= ip_cksum ? PKT_TX_IP_CKSUM : 0;
250 ol_flags |= tcp_cksum ? PKT_TX_TCP_CKSUM : 0;
251 ol_flags |= udp_cksum ? PKT_TX_UDP_CKSUM : 0;
252 ol_flags |= tso ? (tcp_cksum ? PKT_TX_TCP_SEG : PKT_TX_UDP_SEG) : 0;
256 mb->l4_len = vnet_buffer2 (b)->gso_l4_hdr_sz;
257 mb->tso_segsz = vnet_buffer2 (b)->gso_size;
260 mb->ol_flags |= ol_flags;
262 /* we are trying to help compiler here by using local ol_flags with known
263 state of all flags */
264 if (xd->flags & DPDK_DEVICE_FLAG_INTEL_PHDR_CKSUM)
265 rte_net_intel_cksum_flags_prepare (mb, ol_flags);
269 * Transmits the packets on the frame to the interface associated with the
270 * node. It first copies packets on the frame to a per-thread arrays
271 * containing the rte_mbuf pointers.
273 VNET_DEVICE_CLASS_TX_FN (dpdk_device_class) (vlib_main_t * vm,
274 vlib_node_runtime_t * node,
277 dpdk_main_t *dm = &dpdk_main;
278 vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
279 dpdk_device_t *xd = vec_elt_at_index (dm->devices, rd->dev_instance);
280 u32 n_packets = f->n_vectors;
282 u32 thread_index = vm->thread_index;
283 int queue_id = thread_index;
284 u32 tx_pkts = 0, all_or_flags = 0;
285 dpdk_per_thread_data_t *ptd = vec_elt_at_index (dm->per_thread_data,
287 struct rte_mbuf **mb;
290 ASSERT (n_packets <= VLIB_FRAME_SIZE);
292 /* calculate rte_mbuf pointers out of buffer indices */
293 vlib_get_buffers_with_offset (vm, vlib_frame_vector_args (f),
294 (void **) ptd->mbufs, n_packets,
295 -(i32) sizeof (struct rte_mbuf));
300 #if (CLIB_N_PREFETCHES >= 8)
305 dpdk_prefetch_buffer (vm, mb[4]);
306 dpdk_prefetch_buffer (vm, mb[5]);
307 dpdk_prefetch_buffer (vm, mb[6]);
308 dpdk_prefetch_buffer (vm, mb[7]);
310 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
311 b[1] = vlib_buffer_from_rte_mbuf (mb[1]);
312 b[2] = vlib_buffer_from_rte_mbuf (mb[2]);
313 b[3] = vlib_buffer_from_rte_mbuf (mb[3]);
315 or_flags = b[0]->flags | b[1]->flags | b[2]->flags | b[3]->flags;
316 all_or_flags |= or_flags;
318 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
319 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[1]);
320 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[2]);
321 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[3]);
323 if (or_flags & VLIB_BUFFER_NEXT_PRESENT)
325 dpdk_validate_rte_mbuf (vm, b[0], 1);
326 dpdk_validate_rte_mbuf (vm, b[1], 1);
327 dpdk_validate_rte_mbuf (vm, b[2], 1);
328 dpdk_validate_rte_mbuf (vm, b[3], 1);
332 dpdk_validate_rte_mbuf (vm, b[0], 0);
333 dpdk_validate_rte_mbuf (vm, b[1], 0);
334 dpdk_validate_rte_mbuf (vm, b[2], 0);
335 dpdk_validate_rte_mbuf (vm, b[3], 0);
338 if (PREDICT_FALSE ((xd->flags & DPDK_DEVICE_FLAG_TX_OFFLOAD) &&
340 (VNET_BUFFER_F_OFFLOAD_TCP_CKSUM
341 | VNET_BUFFER_F_OFFLOAD_IP_CKSUM
342 | VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))))
344 dpdk_buffer_tx_offload (xd, b[0], mb[0]);
345 dpdk_buffer_tx_offload (xd, b[1], mb[1]);
346 dpdk_buffer_tx_offload (xd, b[2], mb[2]);
347 dpdk_buffer_tx_offload (xd, b[3], mb[3]);
350 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
352 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
353 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[0]);
354 if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
355 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[1]);
356 if (b[2]->flags & VLIB_BUFFER_IS_TRACED)
357 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[2]);
358 if (b[3]->flags & VLIB_BUFFER_IS_TRACED)
359 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[3]);
365 #elif (CLIB_N_PREFETCHES >= 4)
368 vlib_buffer_t *b2, *b3;
371 CLIB_PREFETCH (mb[2], CLIB_CACHE_LINE_BYTES, STORE);
372 CLIB_PREFETCH (mb[3], CLIB_CACHE_LINE_BYTES, STORE);
373 b2 = vlib_buffer_from_rte_mbuf (mb[2]);
374 CLIB_PREFETCH (b2, CLIB_CACHE_LINE_BYTES, LOAD);
375 b3 = vlib_buffer_from_rte_mbuf (mb[3]);
376 CLIB_PREFETCH (b3, CLIB_CACHE_LINE_BYTES, LOAD);
378 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
379 b[1] = vlib_buffer_from_rte_mbuf (mb[1]);
381 or_flags = b[0]->flags | b[1]->flags;
382 all_or_flags |= or_flags;
384 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
385 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[1]);
387 if (or_flags & VLIB_BUFFER_NEXT_PRESENT)
389 dpdk_validate_rte_mbuf (vm, b[0], 1);
390 dpdk_validate_rte_mbuf (vm, b[1], 1);
394 dpdk_validate_rte_mbuf (vm, b[0], 0);
395 dpdk_validate_rte_mbuf (vm, b[1], 0);
398 if (PREDICT_FALSE ((xd->flags & DPDK_DEVICE_FLAG_TX_OFFLOAD) &&
400 (VNET_BUFFER_F_OFFLOAD_TCP_CKSUM
401 | VNET_BUFFER_F_OFFLOAD_IP_CKSUM
402 | VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))))
404 dpdk_buffer_tx_offload (xd, b[0], mb[0]);
405 dpdk_buffer_tx_offload (xd, b[1], mb[1]);
408 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
410 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
411 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[0]);
412 if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
413 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[1]);
423 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
424 all_or_flags |= b[0]->flags;
425 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
427 dpdk_validate_rte_mbuf (vm, b[0], 1);
428 dpdk_buffer_tx_offload (xd, b[0], mb[0]);
430 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
431 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
432 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[0]);
438 /* transmit as many packets as possible */
439 tx_pkts = n_packets = mb - ptd->mbufs;
440 n_left = tx_burst_vector_internal (vm, xd, ptd->mbufs, n_packets);
443 /* If there is no callback then drop any non-transmitted packets */
444 if (PREDICT_FALSE (n_left))
447 vlib_simple_counter_main_t *cm;
448 vnet_main_t *vnm = vnet_get_main ();
450 cm = vec_elt_at_index (vnm->interface_main.sw_if_counters,
451 VNET_INTERFACE_COUNTER_TX_ERROR);
453 vlib_increment_simple_counter (cm, thread_index, xd->sw_if_index,
456 vlib_error_count (vm, node->node_index, DPDK_TX_FUNC_ERROR_PKT_DROP,
460 rte_pktmbuf_free (ptd->mbufs[n_packets - n_left - 1]);
468 dpdk_clear_hw_interface_counters (u32 instance)
470 dpdk_main_t *dm = &dpdk_main;
471 dpdk_device_t *xd = vec_elt_at_index (dm->devices, instance);
473 rte_eth_stats_reset (xd->port_id);
474 rte_eth_xstats_reset (xd->port_id);
477 static clib_error_t *
478 dpdk_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
480 vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
481 uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
482 dpdk_main_t *dm = &dpdk_main;
483 dpdk_device_t *xd = vec_elt_at_index (dm->devices, hif->dev_instance);
485 if (xd->flags & DPDK_DEVICE_FLAG_PMD_INIT_FAIL)
486 return clib_error_return (0, "Interface not initialized");
490 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) == 0)
491 dpdk_device_start (xd);
492 xd->flags |= DPDK_DEVICE_FLAG_ADMIN_UP;
493 f64 now = vlib_time_now (dm->vlib_main);
494 dpdk_update_counters (xd, now);
495 dpdk_update_link_state (xd, now);
499 vnet_hw_interface_set_flags (vnm, xd->hw_if_index, 0);
500 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) != 0)
501 dpdk_device_stop (xd);
502 xd->flags &= ~DPDK_DEVICE_FLAG_ADMIN_UP;
505 return /* no error */ 0;
509 * Dynamically redirect all pkts from a specific interface
510 * to the specified node
513 dpdk_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
516 dpdk_main_t *xm = &dpdk_main;
517 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
518 dpdk_device_t *xd = vec_elt_at_index (xm->devices, hw->dev_instance);
520 /* Shut off redirection */
521 if (node_index == ~0)
523 xd->per_interface_next_index = node_index;
527 xd->per_interface_next_index =
528 vlib_node_add_next (xm->vlib_main, dpdk_input_node.index, node_index);
532 static clib_error_t *
533 dpdk_subif_add_del_function (vnet_main_t * vnm,
535 struct vnet_sw_interface_t *st, int is_add)
537 dpdk_main_t *xm = &dpdk_main;
538 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
539 dpdk_device_t *xd = vec_elt_at_index (xm->devices, hw->dev_instance);
540 vnet_sw_interface_t *t = (vnet_sw_interface_t *) st;
542 u32 prev_subifs = xd->num_subifs;
543 clib_error_t *err = 0;
547 else if (xd->num_subifs)
550 if ((xd->flags & DPDK_DEVICE_FLAG_PMD) == 0)
553 /* currently we program VLANS only for IXGBE VF and I40E VF */
554 if ((xd->pmd != VNET_DPDK_PMD_IXGBEVF) && (xd->pmd != VNET_DPDK_PMD_I40EVF))
557 if (t->sub.eth.flags.no_tags == 1)
560 if ((t->sub.eth.flags.one_tag != 1) || (t->sub.eth.flags.exact_match != 1))
562 xd->num_subifs = prev_subifs;
563 err = clib_error_return (0, "unsupported VLAN setup");
567 vlan_offload = rte_eth_dev_get_vlan_offload (xd->port_id);
568 vlan_offload |= ETH_VLAN_FILTER_OFFLOAD;
570 if ((r = rte_eth_dev_set_vlan_offload (xd->port_id, vlan_offload)))
572 xd->num_subifs = prev_subifs;
573 err = clib_error_return (0, "rte_eth_dev_set_vlan_offload[%d]: err %d",
580 rte_eth_dev_vlan_filter (xd->port_id,
581 t->sub.eth.outer_vlan_id, is_add)))
583 xd->num_subifs = prev_subifs;
584 err = clib_error_return (0, "rte_eth_dev_vlan_filter[%d]: err %d",
591 xd->flags |= DPDK_DEVICE_FLAG_HAVE_SUBIF;
593 xd->flags &= ~DPDK_DEVICE_FLAG_HAVE_SUBIF;
599 VNET_DEVICE_CLASS (dpdk_device_class) = {
601 .tx_function_n_errors = DPDK_TX_FUNC_N_ERROR,
602 .tx_function_error_strings = dpdk_tx_func_error_strings,
603 .format_device_name = format_dpdk_device_name,
604 .format_device = format_dpdk_device,
605 .format_tx_trace = format_dpdk_tx_trace,
606 .clear_counters = dpdk_clear_hw_interface_counters,
607 .admin_up_down_function = dpdk_interface_admin_up_down,
608 .subif_add_del_function = dpdk_subif_add_del_function,
609 .rx_redirect_to_node = dpdk_set_interface_next_node,
610 .mac_addr_change_function = dpdk_set_mac_address,
611 .mac_addr_add_del_function = dpdk_add_del_mac_address,
612 .format_flow = format_dpdk_flow,
613 .flow_ops_function = dpdk_flow_ops_fn,
617 #define UP_DOWN_FLAG_EVENT 1
620 admin_up_down_process (vlib_main_t * vm,
621 vlib_node_runtime_t * rt, vlib_frame_t * f)
623 clib_error_t *error = 0;
625 uword *event_data = 0;
631 vlib_process_wait_for_event (vm);
633 event_type = vlib_process_get_events (vm, &event_data);
635 dpdk_main.admin_up_down_in_progress = 1;
639 case UP_DOWN_FLAG_EVENT:
641 if (vec_len (event_data) == 2)
643 sw_if_index = event_data[0];
644 flags = event_data[1];
646 vnet_sw_interface_set_flags (vnet_get_main (), sw_if_index,
648 clib_error_report (error);
654 vec_reset_length (event_data);
656 dpdk_main.admin_up_down_in_progress = 0;
659 return 0; /* or not */
663 VLIB_REGISTER_NODE (admin_up_down_process_node) = {
664 .function = admin_up_down_process,
665 .type = VLIB_NODE_TYPE_PROCESS,
666 .name = "admin-up-down-process",
667 .process_log2_n_stack_bytes = 17, // 256KB
672 * fd.io coding-style-patch-verification: ON
675 * eval: (c-set-style "gnu")