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/buffer.h>
23 #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_add_del_mac_address (vnet_hw_interface_t * hi,
47 const u8 * address, u8 is_add)
50 dpdk_main_t *dm = &dpdk_main;
51 dpdk_device_t *xd = vec_elt_at_index (dm->devices, hi->dev_instance);
54 error = rte_eth_dev_mac_addr_add (xd->port_id,
55 (struct rte_ether_addr *) address, 0);
57 error = rte_eth_dev_mac_addr_remove (xd->port_id,
58 (struct rte_ether_addr *) address);
62 return clib_error_return (0, "mac address add/del failed: %d", error);
69 dpdk_set_mac_address (vnet_hw_interface_t * hi,
70 const u8 * old_address, const u8 * address)
73 dpdk_main_t *dm = &dpdk_main;
74 dpdk_device_t *xd = vec_elt_at_index (dm->devices, hi->dev_instance);
76 error = rte_eth_dev_default_mac_addr_set (xd->port_id, (void *) address);
80 return clib_error_return (0, "mac address set failed: %d", error);
84 vec_reset_length (xd->default_mac_address);
85 vec_add (xd->default_mac_address, address, sizeof (address));
91 dpdk_tx_trace_buffer (dpdk_main_t * dm, vlib_node_runtime_t * node,
92 dpdk_device_t * xd, u16 queue_id,
93 vlib_buffer_t * buffer)
95 vlib_main_t *vm = vlib_get_main ();
99 mb = rte_mbuf_from_vlib_buffer (buffer);
101 t0 = vlib_add_trace (vm, node, buffer, sizeof (t0[0]));
102 t0->queue_index = queue_id;
103 t0->device_index = xd->device_index;
104 t0->buffer_index = vlib_get_buffer_index (vm, buffer);
105 clib_memcpy_fast (&t0->mb, mb, sizeof (t0->mb));
106 clib_memcpy_fast (&t0->buffer, buffer,
107 sizeof (buffer[0]) - sizeof (buffer->pre_data));
108 clib_memcpy_fast (t0->buffer.pre_data, buffer->data + buffer->current_data,
109 sizeof (t0->buffer.pre_data));
110 clib_memcpy_fast (&t0->data, mb->buf_addr + mb->data_off,
114 static_always_inline void
115 dpdk_validate_rte_mbuf (vlib_main_t * vm, vlib_buffer_t * b,
118 struct rte_mbuf *mb, *first_mb, *last_mb;
119 last_mb = first_mb = mb = rte_mbuf_from_vlib_buffer (b);
121 /* buffer is coming from non-dpdk source so we need to init
123 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_EXT_HDR_VALID) == 0))
124 rte_pktmbuf_reset (mb);
126 first_mb->nb_segs = 1;
127 mb->data_len = b->current_length;
128 mb->pkt_len = maybe_multiseg ? vlib_buffer_length_in_chain (vm, b) :
130 mb->data_off = VLIB_BUFFER_PRE_DATA_SIZE + b->current_data;
132 while (maybe_multiseg && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
134 b = vlib_get_buffer (vm, b->next_buffer);
135 mb = rte_mbuf_from_vlib_buffer (b);
136 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_EXT_HDR_VALID) == 0))
137 rte_pktmbuf_reset (mb);
140 mb->data_len = b->current_length;
141 mb->pkt_len = b->current_length;
142 mb->data_off = VLIB_BUFFER_PRE_DATA_SIZE + b->current_data;
144 if (PREDICT_FALSE (b->ref_count > 1))
146 dpdk_no_cache_mempool_by_buffer_pool_index[b->buffer_pool_index];
151 * This function calls the dpdk's tx_burst function to transmit the packets.
152 * It manages a lock per-device if the device does not
153 * support multiple queues. It returns the number of packets untransmitted
154 * If all packets are transmitted (the normal case), the function returns 0.
157 u32 tx_burst_vector_internal (vlib_main_t * vm,
159 struct rte_mbuf **mb, u32 n_left)
161 dpdk_main_t *dm = &dpdk_main;
167 queue_id = vm->thread_index;
172 * This device only supports one TX queue,
173 * and we're running multi-threaded...
175 if (PREDICT_FALSE (xd->lockp != 0))
177 queue_id = queue_id % xd->tx_q_used;
178 while (clib_atomic_test_and_set (xd->lockp[queue_id]))
180 queue_id = (queue_id + 1) % xd->tx_q_used;
183 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);
195 if (PREDICT_FALSE (xd->lockp != 0))
196 clib_atomic_release (xd->lockp[queue_id]);
198 if (PREDICT_FALSE (n_sent < 0))
200 // emit non-fatal message, bump counter
201 vnet_main_t *vnm = dm->vnet_main;
202 vnet_interface_main_t *im = &vnm->interface_main;
205 node_index = vec_elt_at_index (im->hw_interfaces,
206 xd->hw_if_index)->tx_node_index;
208 vlib_error_count (vm, node_index, DPDK_TX_FUNC_ERROR_BAD_RETVAL, 1);
209 clib_warning ("rte_eth_tx_burst[%d]: error %d",
210 xd->port_id, n_sent);
211 return n_left; // untransmitted packets
216 while (n_sent && n_left && (n_retry > 0));
221 static_always_inline void
222 dpdk_prefetch_buffer (vlib_main_t * vm, struct rte_mbuf *mb)
224 vlib_buffer_t *b = vlib_buffer_from_rte_mbuf (mb);
225 CLIB_PREFETCH (mb, sizeof (struct rte_mbuf), STORE);
226 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, LOAD);
229 static_always_inline void
230 dpdk_buffer_tx_offload (dpdk_device_t * xd, vlib_buffer_t * b,
233 u32 ip_cksum = b->flags & VNET_BUFFER_F_OFFLOAD_IP_CKSUM;
234 u32 tcp_cksum = b->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
235 u32 udp_cksum = b->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
236 int is_ip4 = b->flags & VNET_BUFFER_F_IS_IP4;
237 u32 tso = b->flags & VNET_BUFFER_F_GSO;
240 /* Is there any work for us? */
241 if (PREDICT_TRUE ((ip_cksum | tcp_cksum | udp_cksum | tso) == 0))
244 mb->l2_len = vnet_buffer (b)->l3_hdr_offset - b->current_data;
245 mb->l3_len = vnet_buffer (b)->l4_hdr_offset -
246 vnet_buffer (b)->l3_hdr_offset;
247 mb->outer_l3_len = 0;
248 mb->outer_l2_len = 0;
249 ol_flags = is_ip4 ? PKT_TX_IPV4 : PKT_TX_IPV6;
250 ol_flags |= ip_cksum ? PKT_TX_IP_CKSUM : 0;
251 ol_flags |= tcp_cksum ? PKT_TX_TCP_CKSUM : 0;
252 ol_flags |= udp_cksum ? PKT_TX_UDP_CKSUM : 0;
253 ol_flags |= tso ? (tcp_cksum ? PKT_TX_TCP_SEG : PKT_TX_UDP_SEG) : 0;
257 mb->l4_len = vnet_buffer2 (b)->gso_l4_hdr_sz;
258 mb->tso_segsz = vnet_buffer2 (b)->gso_size;
261 mb->ol_flags |= ol_flags;
263 /* we are trying to help compiler here by using local ol_flags with known
264 state of all flags */
265 if (xd->flags & DPDK_DEVICE_FLAG_INTEL_PHDR_CKSUM)
266 rte_net_intel_cksum_flags_prepare (mb, ol_flags);
270 * Transmits the packets on the frame to the interface associated with the
271 * node. It first copies packets on the frame to a per-thread arrays
272 * containing the rte_mbuf pointers.
274 VNET_DEVICE_CLASS_TX_FN (dpdk_device_class) (vlib_main_t * vm,
275 vlib_node_runtime_t * node,
278 dpdk_main_t *dm = &dpdk_main;
279 vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
280 dpdk_device_t *xd = vec_elt_at_index (dm->devices, rd->dev_instance);
281 u32 n_packets = f->n_vectors;
283 u32 thread_index = vm->thread_index;
284 int queue_id = thread_index;
285 u32 tx_pkts = 0, all_or_flags = 0;
286 dpdk_per_thread_data_t *ptd = vec_elt_at_index (dm->per_thread_data,
288 struct rte_mbuf **mb;
291 ASSERT (n_packets <= VLIB_FRAME_SIZE);
293 /* calculate rte_mbuf pointers out of buffer indices */
294 vlib_get_buffers_with_offset (vm, vlib_frame_vector_args (f),
295 (void **) ptd->mbufs, n_packets,
296 -(i32) sizeof (struct rte_mbuf));
301 #if (CLIB_N_PREFETCHES >= 8)
306 dpdk_prefetch_buffer (vm, mb[4]);
307 dpdk_prefetch_buffer (vm, mb[5]);
308 dpdk_prefetch_buffer (vm, mb[6]);
309 dpdk_prefetch_buffer (vm, mb[7]);
311 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
312 b[1] = vlib_buffer_from_rte_mbuf (mb[1]);
313 b[2] = vlib_buffer_from_rte_mbuf (mb[2]);
314 b[3] = vlib_buffer_from_rte_mbuf (mb[3]);
316 or_flags = b[0]->flags | b[1]->flags | b[2]->flags | b[3]->flags;
317 all_or_flags |= or_flags;
319 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
320 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[1]);
321 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[2]);
322 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[3]);
324 if (or_flags & VLIB_BUFFER_NEXT_PRESENT)
326 dpdk_validate_rte_mbuf (vm, b[0], 1);
327 dpdk_validate_rte_mbuf (vm, b[1], 1);
328 dpdk_validate_rte_mbuf (vm, b[2], 1);
329 dpdk_validate_rte_mbuf (vm, b[3], 1);
333 dpdk_validate_rte_mbuf (vm, b[0], 0);
334 dpdk_validate_rte_mbuf (vm, b[1], 0);
335 dpdk_validate_rte_mbuf (vm, b[2], 0);
336 dpdk_validate_rte_mbuf (vm, b[3], 0);
339 if (PREDICT_FALSE ((xd->flags & DPDK_DEVICE_FLAG_TX_OFFLOAD) &&
341 (VNET_BUFFER_F_OFFLOAD_TCP_CKSUM
342 | VNET_BUFFER_F_OFFLOAD_IP_CKSUM
343 | VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))))
345 dpdk_buffer_tx_offload (xd, b[0], mb[0]);
346 dpdk_buffer_tx_offload (xd, b[1], mb[1]);
347 dpdk_buffer_tx_offload (xd, b[2], mb[2]);
348 dpdk_buffer_tx_offload (xd, b[3], mb[3]);
351 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
353 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
354 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[0]);
355 if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
356 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[1]);
357 if (b[2]->flags & VLIB_BUFFER_IS_TRACED)
358 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[2]);
359 if (b[3]->flags & VLIB_BUFFER_IS_TRACED)
360 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[3]);
366 #elif (CLIB_N_PREFETCHES >= 4)
369 vlib_buffer_t *b2, *b3;
372 CLIB_PREFETCH (mb[2], CLIB_CACHE_LINE_BYTES, STORE);
373 CLIB_PREFETCH (mb[3], CLIB_CACHE_LINE_BYTES, STORE);
374 b2 = vlib_buffer_from_rte_mbuf (mb[2]);
375 CLIB_PREFETCH (b2, CLIB_CACHE_LINE_BYTES, LOAD);
376 b3 = vlib_buffer_from_rte_mbuf (mb[3]);
377 CLIB_PREFETCH (b3, CLIB_CACHE_LINE_BYTES, LOAD);
379 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
380 b[1] = vlib_buffer_from_rte_mbuf (mb[1]);
382 or_flags = b[0]->flags | b[1]->flags;
383 all_or_flags |= or_flags;
385 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
386 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[1]);
388 if (or_flags & VLIB_BUFFER_NEXT_PRESENT)
390 dpdk_validate_rte_mbuf (vm, b[0], 1);
391 dpdk_validate_rte_mbuf (vm, b[1], 1);
395 dpdk_validate_rte_mbuf (vm, b[0], 0);
396 dpdk_validate_rte_mbuf (vm, b[1], 0);
399 if (PREDICT_FALSE ((xd->flags & DPDK_DEVICE_FLAG_TX_OFFLOAD) &&
401 (VNET_BUFFER_F_OFFLOAD_TCP_CKSUM
402 | VNET_BUFFER_F_OFFLOAD_IP_CKSUM
403 | VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))))
405 dpdk_buffer_tx_offload (xd, b[0], mb[0]);
406 dpdk_buffer_tx_offload (xd, b[1], mb[1]);
409 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
411 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
412 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[0]);
413 if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
414 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[1]);
424 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
425 all_or_flags |= b[0]->flags;
426 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
428 dpdk_validate_rte_mbuf (vm, b[0], 1);
429 dpdk_buffer_tx_offload (xd, b[0], mb[0]);
431 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
432 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
433 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[0]);
439 /* transmit as many packets as possible */
440 tx_pkts = n_packets = mb - ptd->mbufs;
441 n_left = tx_burst_vector_internal (vm, xd, ptd->mbufs, n_packets);
444 /* If there is no callback then drop any non-transmitted packets */
445 if (PREDICT_FALSE (n_left))
448 vlib_simple_counter_main_t *cm;
449 vnet_main_t *vnm = vnet_get_main ();
451 cm = vec_elt_at_index (vnm->interface_main.sw_if_counters,
452 VNET_INTERFACE_COUNTER_TX_ERROR);
454 vlib_increment_simple_counter (cm, thread_index, xd->sw_if_index,
457 vlib_error_count (vm, node->node_index, DPDK_TX_FUNC_ERROR_PKT_DROP,
461 rte_pktmbuf_free (ptd->mbufs[n_packets - n_left - 1]);
469 dpdk_clear_hw_interface_counters (u32 instance)
471 dpdk_main_t *dm = &dpdk_main;
472 dpdk_device_t *xd = vec_elt_at_index (dm->devices, instance);
474 rte_eth_stats_reset (xd->port_id);
475 rte_eth_xstats_reset (xd->port_id);
478 static clib_error_t *
479 dpdk_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
481 vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
482 uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
483 dpdk_main_t *dm = &dpdk_main;
484 dpdk_device_t *xd = vec_elt_at_index (dm->devices, hif->dev_instance);
486 if (xd->flags & DPDK_DEVICE_FLAG_PMD_INIT_FAIL)
487 return clib_error_return (0, "Interface not initialized");
491 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) == 0)
492 dpdk_device_start (xd);
493 xd->flags |= DPDK_DEVICE_FLAG_ADMIN_UP;
494 f64 now = vlib_time_now (dm->vlib_main);
495 dpdk_update_counters (xd, now);
496 dpdk_update_link_state (xd, now);
500 vnet_hw_interface_set_flags (vnm, xd->hw_if_index, 0);
501 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) != 0)
502 dpdk_device_stop (xd);
503 xd->flags &= ~DPDK_DEVICE_FLAG_ADMIN_UP;
506 return /* no error */ 0;
510 * Dynamically redirect all pkts from a specific interface
511 * to the specified node
514 dpdk_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
517 dpdk_main_t *xm = &dpdk_main;
518 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
519 dpdk_device_t *xd = vec_elt_at_index (xm->devices, hw->dev_instance);
521 /* Shut off redirection */
522 if (node_index == ~0)
524 xd->per_interface_next_index = node_index;
528 xd->per_interface_next_index =
529 vlib_node_add_next (xm->vlib_main, dpdk_input_node.index, node_index);
533 static clib_error_t *
534 dpdk_subif_add_del_function (vnet_main_t * vnm,
536 struct vnet_sw_interface_t *st, int is_add)
538 dpdk_main_t *xm = &dpdk_main;
539 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
540 dpdk_device_t *xd = vec_elt_at_index (xm->devices, hw->dev_instance);
541 vnet_sw_interface_t *t = (vnet_sw_interface_t *) st;
543 u32 prev_subifs = xd->num_subifs;
544 clib_error_t *err = 0;
548 else if (xd->num_subifs)
551 if ((xd->flags & DPDK_DEVICE_FLAG_PMD) == 0)
554 /* currently we program VLANS only for IXGBE VF and I40E VF */
555 if ((xd->pmd != VNET_DPDK_PMD_IXGBEVF) && (xd->pmd != VNET_DPDK_PMD_I40EVF))
558 if (t->sub.eth.flags.no_tags == 1)
561 if ((t->sub.eth.flags.one_tag != 1) || (t->sub.eth.flags.exact_match != 1))
563 xd->num_subifs = prev_subifs;
564 err = clib_error_return (0, "unsupported VLAN setup");
568 vlan_offload = rte_eth_dev_get_vlan_offload (xd->port_id);
569 vlan_offload |= ETH_VLAN_FILTER_OFFLOAD;
571 if ((r = rte_eth_dev_set_vlan_offload (xd->port_id, vlan_offload)))
573 xd->num_subifs = prev_subifs;
574 err = clib_error_return (0, "rte_eth_dev_set_vlan_offload[%d]: err %d",
581 rte_eth_dev_vlan_filter (xd->port_id,
582 t->sub.eth.outer_vlan_id, is_add)))
584 xd->num_subifs = prev_subifs;
585 err = clib_error_return (0, "rte_eth_dev_vlan_filter[%d]: err %d",
592 xd->flags |= DPDK_DEVICE_FLAG_HAVE_SUBIF;
594 xd->flags &= ~DPDK_DEVICE_FLAG_HAVE_SUBIF;
600 VNET_DEVICE_CLASS (dpdk_device_class) = {
602 .tx_function_n_errors = DPDK_TX_FUNC_N_ERROR,
603 .tx_function_error_strings = dpdk_tx_func_error_strings,
604 .format_device_name = format_dpdk_device_name,
605 .format_device = format_dpdk_device,
606 .format_tx_trace = format_dpdk_tx_trace,
607 .clear_counters = dpdk_clear_hw_interface_counters,
608 .admin_up_down_function = dpdk_interface_admin_up_down,
609 .subif_add_del_function = dpdk_subif_add_del_function,
610 .rx_redirect_to_node = dpdk_set_interface_next_node,
611 .mac_addr_change_function = dpdk_set_mac_address,
612 .mac_addr_add_del_function = dpdk_add_del_mac_address,
613 .format_flow = format_dpdk_flow,
614 .flow_ops_function = dpdk_flow_ops_fn,
618 #define UP_DOWN_FLAG_EVENT 1
621 admin_up_down_process (vlib_main_t * vm,
622 vlib_node_runtime_t * rt, vlib_frame_t * f)
624 clib_error_t *error = 0;
626 uword *event_data = 0;
632 vlib_process_wait_for_event (vm);
634 event_type = vlib_process_get_events (vm, &event_data);
636 dpdk_main.admin_up_down_in_progress = 1;
640 case UP_DOWN_FLAG_EVENT:
642 if (vec_len (event_data) == 2)
644 sw_if_index = event_data[0];
645 flags = event_data[1];
647 vnet_sw_interface_set_flags (vnet_get_main (), sw_if_index,
649 clib_error_report (error);
655 vec_reset_length (event_data);
657 dpdk_main.admin_up_down_in_progress = 0;
660 return 0; /* or not */
664 VLIB_REGISTER_NODE (admin_up_down_process_node) = {
665 .function = admin_up_down_process,
666 .type = VLIB_NODE_TYPE_PROCESS,
667 .name = "admin-up-down-process",
668 .process_log2_n_stack_bytes = 17, // 256KB
673 * fd.io coding-style-patch-verification: ON
676 * eval: (c-set-style "gnu")