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, 2 * CLIB_CACHE_LINE_BYTES, 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;
231 /* Is there any work for us? */
232 if (PREDICT_TRUE ((ip_cksum | tcp_cksum | udp_cksum) == 0))
235 mb->l2_len = vnet_buffer (b)->l3_hdr_offset - b->current_data;
236 mb->l3_len = vnet_buffer (b)->l4_hdr_offset -
237 vnet_buffer (b)->l3_hdr_offset;
238 mb->outer_l3_len = 0;
239 mb->outer_l2_len = 0;
240 ol_flags = is_ip4 ? PKT_TX_IPV4 : PKT_TX_IPV6;
241 ol_flags |= ip_cksum ? PKT_TX_IP_CKSUM : 0;
242 ol_flags |= tcp_cksum ? PKT_TX_TCP_CKSUM : 0;
243 ol_flags |= udp_cksum ? PKT_TX_UDP_CKSUM : 0;
244 mb->ol_flags |= ol_flags;
246 /* we are trying to help compiler here by using local ol_flags with known
247 state of all flags */
248 if (xd->flags & DPDK_DEVICE_FLAG_INTEL_PHDR_CKSUM)
249 rte_net_intel_cksum_flags_prepare (mb, ol_flags);
253 * Transmits the packets on the frame to the interface associated with the
254 * node. It first copies packets on the frame to a per-thread arrays
255 * containing the rte_mbuf pointers.
257 VNET_DEVICE_CLASS_TX_FN (dpdk_device_class) (vlib_main_t * vm,
258 vlib_node_runtime_t * node,
261 dpdk_main_t *dm = &dpdk_main;
262 vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
263 dpdk_device_t *xd = vec_elt_at_index (dm->devices, rd->dev_instance);
264 u32 n_packets = f->n_vectors;
266 u32 thread_index = vm->thread_index;
267 int queue_id = thread_index;
268 u32 tx_pkts = 0, all_or_flags = 0;
269 dpdk_per_thread_data_t *ptd = vec_elt_at_index (dm->per_thread_data,
271 struct rte_mbuf **mb;
274 ASSERT (n_packets <= VLIB_FRAME_SIZE);
276 /* calculate rte_mbuf pointers out of buffer indices */
277 vlib_get_buffers_with_offset (vm, vlib_frame_vector_args (f),
278 (void **) ptd->mbufs, n_packets,
279 -(i32) sizeof (struct rte_mbuf));
288 dpdk_prefetch_buffer (vm, mb[4]);
289 dpdk_prefetch_buffer (vm, mb[5]);
290 dpdk_prefetch_buffer (vm, mb[6]);
291 dpdk_prefetch_buffer (vm, mb[7]);
293 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
294 b[1] = vlib_buffer_from_rte_mbuf (mb[1]);
295 b[2] = vlib_buffer_from_rte_mbuf (mb[2]);
296 b[3] = vlib_buffer_from_rte_mbuf (mb[3]);
298 or_flags = b[0]->flags | b[1]->flags | b[2]->flags | b[3]->flags;
299 all_or_flags |= or_flags;
301 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
302 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[1]);
303 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[2]);
304 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[3]);
306 if (or_flags & VLIB_BUFFER_NEXT_PRESENT)
308 dpdk_validate_rte_mbuf (vm, b[0], 1);
309 dpdk_validate_rte_mbuf (vm, b[1], 1);
310 dpdk_validate_rte_mbuf (vm, b[2], 1);
311 dpdk_validate_rte_mbuf (vm, b[3], 1);
315 dpdk_validate_rte_mbuf (vm, b[0], 0);
316 dpdk_validate_rte_mbuf (vm, b[1], 0);
317 dpdk_validate_rte_mbuf (vm, b[2], 0);
318 dpdk_validate_rte_mbuf (vm, b[3], 0);
321 if (PREDICT_FALSE ((xd->flags & DPDK_DEVICE_FLAG_TX_OFFLOAD) &&
323 (VNET_BUFFER_F_OFFLOAD_TCP_CKSUM
324 | VNET_BUFFER_F_OFFLOAD_IP_CKSUM
325 | VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))))
327 dpdk_buffer_tx_offload (xd, b[0], mb[0]);
328 dpdk_buffer_tx_offload (xd, b[1], mb[1]);
329 dpdk_buffer_tx_offload (xd, b[2], mb[2]);
330 dpdk_buffer_tx_offload (xd, b[3], mb[3]);
333 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
335 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
336 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[0]);
337 if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
338 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[1]);
339 if (b[2]->flags & VLIB_BUFFER_IS_TRACED)
340 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[2]);
341 if (b[3]->flags & VLIB_BUFFER_IS_TRACED)
342 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[3]);
350 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
351 all_or_flags |= b[0]->flags;
352 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
354 dpdk_validate_rte_mbuf (vm, b[0], 1);
355 dpdk_buffer_tx_offload (xd, b[0], mb[0]);
357 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
358 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
359 dpdk_tx_trace_buffer (dm, node, xd, queue_id, b[0]);
365 /* transmit as many packets as possible */
366 tx_pkts = n_packets = mb - ptd->mbufs;
367 n_left = tx_burst_vector_internal (vm, xd, ptd->mbufs, n_packets);
370 /* If there is no callback then drop any non-transmitted packets */
371 if (PREDICT_FALSE (n_left))
374 vlib_simple_counter_main_t *cm;
375 vnet_main_t *vnm = vnet_get_main ();
377 cm = vec_elt_at_index (vnm->interface_main.sw_if_counters,
378 VNET_INTERFACE_COUNTER_TX_ERROR);
380 vlib_increment_simple_counter (cm, thread_index, xd->sw_if_index,
383 vlib_error_count (vm, node->node_index, DPDK_TX_FUNC_ERROR_PKT_DROP,
387 rte_pktmbuf_free (ptd->mbufs[n_packets - n_left - 1]);
395 dpdk_clear_hw_interface_counters (u32 instance)
397 dpdk_main_t *dm = &dpdk_main;
398 dpdk_device_t *xd = vec_elt_at_index (dm->devices, instance);
400 rte_eth_xstats_reset (xd->port_id);
403 static clib_error_t *
404 dpdk_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
406 vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
407 uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
408 dpdk_main_t *dm = &dpdk_main;
409 dpdk_device_t *xd = vec_elt_at_index (dm->devices, hif->dev_instance);
411 if (xd->flags & DPDK_DEVICE_FLAG_PMD_INIT_FAIL)
412 return clib_error_return (0, "Interface not initialized");
416 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) == 0)
417 dpdk_device_start (xd);
418 xd->flags |= DPDK_DEVICE_FLAG_ADMIN_UP;
419 f64 now = vlib_time_now (dm->vlib_main);
420 dpdk_update_counters (xd, now);
421 dpdk_update_link_state (xd, now);
425 vnet_hw_interface_set_flags (vnm, xd->hw_if_index, 0);
426 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) != 0)
427 dpdk_device_stop (xd);
428 xd->flags &= ~DPDK_DEVICE_FLAG_ADMIN_UP;
431 return /* no error */ 0;
435 * Dynamically redirect all pkts from a specific interface
436 * to the specified node
439 dpdk_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
442 dpdk_main_t *xm = &dpdk_main;
443 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
444 dpdk_device_t *xd = vec_elt_at_index (xm->devices, hw->dev_instance);
446 /* Shut off redirection */
447 if (node_index == ~0)
449 xd->per_interface_next_index = node_index;
453 xd->per_interface_next_index =
454 vlib_node_add_next (xm->vlib_main, dpdk_input_node.index, node_index);
458 static clib_error_t *
459 dpdk_subif_add_del_function (vnet_main_t * vnm,
461 struct vnet_sw_interface_t *st, int is_add)
463 dpdk_main_t *xm = &dpdk_main;
464 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
465 dpdk_device_t *xd = vec_elt_at_index (xm->devices, hw->dev_instance);
466 vnet_sw_interface_t *t = (vnet_sw_interface_t *) st;
468 u32 prev_subifs = xd->num_subifs;
469 clib_error_t *err = 0;
473 else if (xd->num_subifs)
476 if ((xd->flags & DPDK_DEVICE_FLAG_PMD) == 0)
479 /* currently we program VLANS only for IXGBE VF and I40E VF */
480 if ((xd->pmd != VNET_DPDK_PMD_IXGBEVF) && (xd->pmd != VNET_DPDK_PMD_I40EVF))
483 if (t->sub.eth.flags.no_tags == 1)
486 if ((t->sub.eth.flags.one_tag != 1) || (t->sub.eth.flags.exact_match != 1))
488 xd->num_subifs = prev_subifs;
489 err = clib_error_return (0, "unsupported VLAN setup");
493 vlan_offload = rte_eth_dev_get_vlan_offload (xd->port_id);
494 vlan_offload |= ETH_VLAN_FILTER_OFFLOAD;
496 if ((r = rte_eth_dev_set_vlan_offload (xd->port_id, vlan_offload)))
498 xd->num_subifs = prev_subifs;
499 err = clib_error_return (0, "rte_eth_dev_set_vlan_offload[%d]: err %d",
506 rte_eth_dev_vlan_filter (xd->port_id,
507 t->sub.eth.outer_vlan_id, is_add)))
509 xd->num_subifs = prev_subifs;
510 err = clib_error_return (0, "rte_eth_dev_vlan_filter[%d]: err %d",
517 xd->flags |= DPDK_DEVICE_FLAG_HAVE_SUBIF;
519 xd->flags &= ~DPDK_DEVICE_FLAG_HAVE_SUBIF;
525 VNET_DEVICE_CLASS (dpdk_device_class) = {
527 .tx_function_n_errors = DPDK_TX_FUNC_N_ERROR,
528 .tx_function_error_strings = dpdk_tx_func_error_strings,
529 .format_device_name = format_dpdk_device_name,
530 .format_device = format_dpdk_device,
531 .format_tx_trace = format_dpdk_tx_trace,
532 .clear_counters = dpdk_clear_hw_interface_counters,
533 .admin_up_down_function = dpdk_interface_admin_up_down,
534 .subif_add_del_function = dpdk_subif_add_del_function,
535 .rx_redirect_to_node = dpdk_set_interface_next_node,
536 .mac_addr_change_function = dpdk_set_mac_address,
537 .format_flow = format_dpdk_flow,
538 .flow_ops_function = dpdk_flow_ops_fn,
542 #define UP_DOWN_FLAG_EVENT 1
545 admin_up_down_process (vlib_main_t * vm,
546 vlib_node_runtime_t * rt, vlib_frame_t * f)
548 clib_error_t *error = 0;
550 uword *event_data = 0;
556 vlib_process_wait_for_event (vm);
558 event_type = vlib_process_get_events (vm, &event_data);
560 dpdk_main.admin_up_down_in_progress = 1;
564 case UP_DOWN_FLAG_EVENT:
566 if (vec_len (event_data) == 2)
568 sw_if_index = event_data[0];
569 flags = event_data[1];
571 vnet_sw_interface_set_flags (vnet_get_main (), sw_if_index,
573 clib_error_report (error);
579 vec_reset_length (event_data);
581 dpdk_main.admin_up_down_in_progress = 0;
584 return 0; /* or not */
588 VLIB_REGISTER_NODE (admin_up_down_process_node) = {
589 .function = admin_up_down_process,
590 .type = VLIB_NODE_TYPE_PROCESS,
591 .name = "admin-up-down-process",
592 .process_log2_n_stack_bytes = 17, // 256KB
597 * fd.io coding-style-patch-verification: ON
600 * eval: (c-set-style "gnu")