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_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;
97 last_mb = first_mb = mb = rte_mbuf_from_vlib_buffer (b);
99 /* buffer is coming from non-dpdk source so we need to init
101 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_EXT_HDR_VALID) == 0))
102 rte_pktmbuf_reset (mb);
104 first_mb->nb_segs = 1;
105 mb->data_len = b->current_length;
106 mb->pkt_len = maybe_multiseg ? vlib_buffer_length_in_chain (vm, b) :
108 mb->data_off = VLIB_BUFFER_PRE_DATA_SIZE + b->current_data;
110 while (maybe_multiseg && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
112 b = vlib_get_buffer (vm, b->next_buffer);
113 mb = rte_mbuf_from_vlib_buffer (b);
114 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_EXT_HDR_VALID) == 0))
115 rte_pktmbuf_reset (mb);
118 mb->data_len = b->current_length;
119 mb->pkt_len = b->current_length;
120 mb->data_off = VLIB_BUFFER_PRE_DATA_SIZE + b->current_data;
122 if (PREDICT_FALSE (b->ref_count > 1))
124 dpdk_no_cache_mempool_by_buffer_pool_index[b->buffer_pool_index];
129 * This function calls the dpdk's tx_burst function to transmit the packets.
130 * It manages a lock per-device if the device does not
131 * support multiple queues. It returns the number of packets untransmitted
132 * If all packets are transmitted (the normal case), the function returns 0.
135 u32 tx_burst_vector_internal (vlib_main_t * vm,
137 struct rte_mbuf **mb, u32 n_left)
139 dpdk_main_t *dm = &dpdk_main;
145 queue_id = vm->thread_index;
150 * This device only supports one TX queue,
151 * and we're running multi-threaded...
153 if (PREDICT_FALSE (xd->lockp != 0))
155 queue_id = queue_id % xd->tx_q_used;
156 while (clib_atomic_test_and_set (xd->lockp[queue_id]))
158 queue_id = (queue_id + 1) % xd->tx_q_used;
162 if (PREDICT_FALSE (xd->flags & DPDK_DEVICE_FLAG_HQOS)) /* HQoS ON */
164 /* no wrap, transmit in one burst */
165 dpdk_device_hqos_per_worker_thread_t *hqos =
166 &xd->hqos_wt[vm->thread_index];
168 ASSERT (hqos->swq != NULL);
170 dpdk_hqos_metadata_set (hqos, mb, n_left);
171 n_sent = rte_ring_sp_enqueue_burst (hqos->swq, (void **) mb,
176 if (PREDICT_TRUE (xd->flags & DPDK_DEVICE_FLAG_PMD))
178 /* no wrap, transmit in one burst */
179 n_sent = rte_eth_tx_burst (xd->port_id, queue_id, mb, n_left);
187 if (PREDICT_FALSE (xd->lockp != 0))
188 clib_atomic_release (xd->lockp[queue_id]);
190 if (PREDICT_FALSE (n_sent < 0))
192 // emit non-fatal message, bump counter
193 vnet_main_t *vnm = dm->vnet_main;
194 vnet_interface_main_t *im = &vnm->interface_main;
197 node_index = vec_elt_at_index (im->hw_interfaces,
198 xd->hw_if_index)->tx_node_index;
200 vlib_error_count (vm, node_index, DPDK_TX_FUNC_ERROR_BAD_RETVAL, 1);
201 clib_warning ("rte_eth_tx_burst[%d]: error %d",
202 xd->port_id, n_sent);
203 return n_left; // untransmitted packets
208 while (n_sent && n_left && (n_retry > 0));
213 static_always_inline void
214 dpdk_prefetch_buffer (vlib_main_t * vm, struct rte_mbuf *mb)
216 vlib_buffer_t *b = vlib_buffer_from_rte_mbuf (mb);
217 CLIB_PREFETCH (mb, sizeof (struct rte_mbuf), STORE);
218 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, LOAD);
221 static_always_inline void
222 dpdk_buffer_tx_offload (dpdk_device_t * xd, vlib_buffer_t * b,
225 u32 ip_cksum = b->flags & VNET_BUFFER_F_OFFLOAD_IP_CKSUM;
226 u32 tcp_cksum = b->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
227 u32 udp_cksum = b->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
228 int is_ip4 = b->flags & VNET_BUFFER_F_IS_IP4;
229 u32 tso = b->flags & VNET_BUFFER_F_GSO;
232 /* Is there any work for us? */
233 if (PREDICT_TRUE ((ip_cksum | tcp_cksum | udp_cksum | tso) == 0))
236 mb->l2_len = vnet_buffer (b)->l3_hdr_offset - b->current_data;
237 mb->l3_len = vnet_buffer (b)->l4_hdr_offset -
238 vnet_buffer (b)->l3_hdr_offset;
239 mb->outer_l3_len = 0;
240 mb->outer_l2_len = 0;
241 ol_flags = is_ip4 ? PKT_TX_IPV4 : PKT_TX_IPV6;
242 ol_flags |= ip_cksum ? PKT_TX_IP_CKSUM : 0;
243 ol_flags |= tcp_cksum ? PKT_TX_TCP_CKSUM : 0;
244 ol_flags |= udp_cksum ? PKT_TX_UDP_CKSUM : 0;
245 ol_flags |= tso ? (tcp_cksum ? PKT_TX_TCP_SEG : PKT_TX_UDP_SEG) : 0;
249 mb->l4_len = vnet_buffer2 (b)->gso_l4_hdr_sz;
250 mb->tso_segsz = vnet_buffer2 (b)->gso_size;
253 mb->ol_flags |= ol_flags;
255 /* we are trying to help compiler here by using local ol_flags with known
256 state of all flags */
257 if (xd->flags & DPDK_DEVICE_FLAG_INTEL_PHDR_CKSUM)
258 rte_net_intel_cksum_flags_prepare (mb, ol_flags);
262 * Transmits the packets on the frame to the interface associated with the
263 * node. It first copies packets on the frame to a per-thread arrays
264 * containing the rte_mbuf pointers.
266 VNET_DEVICE_CLASS_TX_FN (dpdk_device_class) (vlib_main_t * vm,
267 vlib_node_runtime_t * node,
270 dpdk_main_t *dm = &dpdk_main;
271 vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
272 dpdk_device_t *xd = vec_elt_at_index (dm->devices, rd->dev_instance);
273 u32 n_packets = f->n_vectors;
275 u32 thread_index = vm->thread_index;
276 int queue_id = thread_index;
277 u32 tx_pkts = 0, all_or_flags = 0;
278 dpdk_per_thread_data_t *ptd = vec_elt_at_index (dm->per_thread_data,
280 struct rte_mbuf **mb;
283 ASSERT (n_packets <= VLIB_FRAME_SIZE);
285 /* calculate rte_mbuf pointers out of buffer indices */
286 vlib_get_buffers_with_offset (vm, vlib_frame_vector_args (f),
287 (void **) ptd->mbufs, n_packets,
288 -(i32) sizeof (struct rte_mbuf));
297 dpdk_prefetch_buffer (vm, mb[4]);
298 dpdk_prefetch_buffer (vm, mb[5]);
299 dpdk_prefetch_buffer (vm, mb[6]);
300 dpdk_prefetch_buffer (vm, mb[7]);
302 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
303 b[1] = vlib_buffer_from_rte_mbuf (mb[1]);
304 b[2] = vlib_buffer_from_rte_mbuf (mb[2]);
305 b[3] = vlib_buffer_from_rte_mbuf (mb[3]);
307 or_flags = b[0]->flags | b[1]->flags | b[2]->flags | b[3]->flags;
308 all_or_flags |= or_flags;
310 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
311 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[1]);
312 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[2]);
313 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[3]);
315 if (or_flags & VLIB_BUFFER_NEXT_PRESENT)
317 dpdk_validate_rte_mbuf (vm, b[0], 1);
318 dpdk_validate_rte_mbuf (vm, b[1], 1);
319 dpdk_validate_rte_mbuf (vm, b[2], 1);
320 dpdk_validate_rte_mbuf (vm, b[3], 1);
324 dpdk_validate_rte_mbuf (vm, b[0], 0);
325 dpdk_validate_rte_mbuf (vm, b[1], 0);
326 dpdk_validate_rte_mbuf (vm, b[2], 0);
327 dpdk_validate_rte_mbuf (vm, b[3], 0);
330 if (PREDICT_FALSE ((xd->flags & DPDK_DEVICE_FLAG_TX_OFFLOAD) &&
332 (VNET_BUFFER_F_OFFLOAD_TCP_CKSUM
333 | VNET_BUFFER_F_OFFLOAD_IP_CKSUM
334 | VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))))
336 dpdk_buffer_tx_offload (xd, b[0], mb[0]);
337 dpdk_buffer_tx_offload (xd, b[1], mb[1]);
338 dpdk_buffer_tx_offload (xd, b[2], mb[2]);
339 dpdk_buffer_tx_offload (xd, b[3], mb[3]);
342 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
344 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
345 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[0]);
346 if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
347 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[1]);
348 if (b[2]->flags & VLIB_BUFFER_IS_TRACED)
349 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[2]);
350 if (b[3]->flags & VLIB_BUFFER_IS_TRACED)
351 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[3]);
359 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
360 all_or_flags |= b[0]->flags;
361 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
363 dpdk_validate_rte_mbuf (vm, b[0], 1);
364 dpdk_buffer_tx_offload (xd, b[0], mb[0]);
366 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
367 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
368 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[0]);
374 /* transmit as many packets as possible */
375 tx_pkts = n_packets = mb - ptd->mbufs;
376 n_left = tx_burst_vector_internal (vm, xd, ptd->mbufs, n_packets);
379 /* If there is no callback then drop any non-transmitted packets */
380 if (PREDICT_FALSE (n_left))
383 vlib_simple_counter_main_t *cm;
384 vnet_main_t *vnm = vnet_get_main ();
386 cm = vec_elt_at_index (vnm->interface_main.sw_if_counters,
387 VNET_INTERFACE_COUNTER_TX_ERROR);
389 vlib_increment_simple_counter (cm, thread_index, xd->sw_if_index,
392 vlib_error_count (vm, node->node_index, DPDK_TX_FUNC_ERROR_PKT_DROP,
396 rte_pktmbuf_free (ptd->mbufs[n_packets - n_left - 1]);
404 dpdk_clear_hw_interface_counters (u32 instance)
406 dpdk_main_t *dm = &dpdk_main;
407 dpdk_device_t *xd = vec_elt_at_index (dm->devices, instance);
409 rte_eth_stats_reset (xd->port_id);
410 rte_eth_xstats_reset (xd->port_id);
413 static clib_error_t *
414 dpdk_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
416 vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
417 uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
418 dpdk_main_t *dm = &dpdk_main;
419 dpdk_device_t *xd = vec_elt_at_index (dm->devices, hif->dev_instance);
421 if (xd->flags & DPDK_DEVICE_FLAG_PMD_INIT_FAIL)
422 return clib_error_return (0, "Interface not initialized");
426 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) == 0)
427 dpdk_device_start (xd);
428 xd->flags |= DPDK_DEVICE_FLAG_ADMIN_UP;
429 f64 now = vlib_time_now (dm->vlib_main);
430 dpdk_update_counters (xd, now);
431 dpdk_update_link_state (xd, now);
435 vnet_hw_interface_set_flags (vnm, xd->hw_if_index, 0);
436 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) != 0)
437 dpdk_device_stop (xd);
438 xd->flags &= ~DPDK_DEVICE_FLAG_ADMIN_UP;
441 return /* no error */ 0;
445 * Dynamically redirect all pkts from a specific interface
446 * to the specified node
449 dpdk_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
452 dpdk_main_t *xm = &dpdk_main;
453 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
454 dpdk_device_t *xd = vec_elt_at_index (xm->devices, hw->dev_instance);
456 /* Shut off redirection */
457 if (node_index == ~0)
459 xd->per_interface_next_index = node_index;
463 xd->per_interface_next_index =
464 vlib_node_add_next (xm->vlib_main, dpdk_input_node.index, node_index);
468 static clib_error_t *
469 dpdk_subif_add_del_function (vnet_main_t * vnm,
471 struct vnet_sw_interface_t *st, int is_add)
473 dpdk_main_t *xm = &dpdk_main;
474 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
475 dpdk_device_t *xd = vec_elt_at_index (xm->devices, hw->dev_instance);
476 vnet_sw_interface_t *t = (vnet_sw_interface_t *) st;
478 u32 prev_subifs = xd->num_subifs;
479 clib_error_t *err = 0;
483 else if (xd->num_subifs)
486 if ((xd->flags & DPDK_DEVICE_FLAG_PMD) == 0)
489 /* currently we program VLANS only for IXGBE VF and I40E VF */
490 if ((xd->pmd != VNET_DPDK_PMD_IXGBEVF) && (xd->pmd != VNET_DPDK_PMD_I40EVF))
493 if (t->sub.eth.flags.no_tags == 1)
496 if ((t->sub.eth.flags.one_tag != 1) || (t->sub.eth.flags.exact_match != 1))
498 xd->num_subifs = prev_subifs;
499 err = clib_error_return (0, "unsupported VLAN setup");
503 vlan_offload = rte_eth_dev_get_vlan_offload (xd->port_id);
504 vlan_offload |= ETH_VLAN_FILTER_OFFLOAD;
506 if ((r = rte_eth_dev_set_vlan_offload (xd->port_id, vlan_offload)))
508 xd->num_subifs = prev_subifs;
509 err = clib_error_return (0, "rte_eth_dev_set_vlan_offload[%d]: err %d",
516 rte_eth_dev_vlan_filter (xd->port_id,
517 t->sub.eth.outer_vlan_id, is_add)))
519 xd->num_subifs = prev_subifs;
520 err = clib_error_return (0, "rte_eth_dev_vlan_filter[%d]: err %d",
527 xd->flags |= DPDK_DEVICE_FLAG_HAVE_SUBIF;
529 xd->flags &= ~DPDK_DEVICE_FLAG_HAVE_SUBIF;
535 VNET_DEVICE_CLASS (dpdk_device_class) = {
537 .tx_function_n_errors = DPDK_TX_FUNC_N_ERROR,
538 .tx_function_error_strings = dpdk_tx_func_error_strings,
539 .format_device_name = format_dpdk_device_name,
540 .format_device = format_dpdk_device,
541 .format_tx_trace = format_dpdk_tx_trace,
542 .clear_counters = dpdk_clear_hw_interface_counters,
543 .admin_up_down_function = dpdk_interface_admin_up_down,
544 .subif_add_del_function = dpdk_subif_add_del_function,
545 .rx_redirect_to_node = dpdk_set_interface_next_node,
546 .mac_addr_change_function = dpdk_set_mac_address,
547 .format_flow = format_dpdk_flow,
548 .flow_ops_function = dpdk_flow_ops_fn,
552 #define UP_DOWN_FLAG_EVENT 1
555 admin_up_down_process (vlib_main_t * vm,
556 vlib_node_runtime_t * rt, vlib_frame_t * f)
558 clib_error_t *error = 0;
560 uword *event_data = 0;
566 vlib_process_wait_for_event (vm);
568 event_type = vlib_process_get_events (vm, &event_data);
570 dpdk_main.admin_up_down_in_progress = 1;
574 case UP_DOWN_FLAG_EVENT:
576 if (vec_len (event_data) == 2)
578 sw_if_index = event_data[0];
579 flags = event_data[1];
581 vnet_sw_interface_set_flags (vnet_get_main (), sw_if_index,
583 clib_error_report (error);
589 vec_reset_length (event_data);
591 dpdk_main.admin_up_down_in_progress = 0;
594 return 0; /* or not */
598 VLIB_REGISTER_NODE (admin_up_down_process_node) = {
599 .function = admin_up_down_process,
600 .type = VLIB_NODE_TYPE_PROCESS,
601 .name = "admin-up-down-process",
602 .process_log2_n_stack_bytes = 17, // 256KB
607 * fd.io coding-style-patch-verification: ON
610 * eval: (c-set-style "gnu")