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 #ifndef __included_dpdk_h__
16 #define __included_dpdk_h__
18 /* $$$$ We should rename always_inline -> clib_always_inline */
21 #include <rte_config.h>
23 #include <rte_common.h>
26 #include <rte_memory.h>
27 #include <rte_memzone.h>
28 #include <rte_tailq.h>
30 #include <rte_per_lcore.h>
31 #include <rte_launch.h>
32 #include <rte_atomic.h>
33 #include <rte_cycles.h>
34 #include <rte_prefetch.h>
35 #include <rte_lcore.h>
36 #include <rte_per_lcore.h>
37 #include <rte_branch_prediction.h>
38 #include <rte_interrupts.h>
40 #include <rte_random.h>
41 #include <rte_debug.h>
42 #include <rte_ether.h>
43 #include <rte_ethdev.h>
45 #include <rte_mempool.h>
50 #include <rte_virtio_net.h>
51 #include <rte_pci_dev_ids.h>
52 #include <rte_version.h>
53 #include <rte_eth_bond.h>
55 #include <vnet/unix/pcap.h>
56 #include <vnet/devices/virtio/vhost-user.h>
59 #define always_inline static inline
61 #define always_inline static inline __attribute__ ((__always_inline__))
64 #if RTE_VERSION < RTE_VERSION_NUM(16, 7, 0, 0)
65 #define DPDK_VHOST_USER 1
67 #define DPDK_VHOST_USER 0
70 #include <vlib/pci/pci.h>
72 #define NB_MBUF (16<<10)
74 extern vnet_device_class_t dpdk_device_class;
75 extern vlib_node_registration_t dpdk_input_node;
76 extern vlib_node_registration_t handoff_dispatch_node;
80 VNET_DPDK_DEV_ETH = 1, /* Standard DPDK PMD driver */
81 VNET_DPDK_DEV_KNI, /* Kernel NIC Interface */
82 VNET_DPDK_DEV_VHOST_USER,
83 VNET_DPDK_DEV_UNKNOWN, /* must be last */
86 #define foreach_dpdk_pmd \
87 _ ("rte_nicvf_pmd", THUNDERX) \
88 _ ("rte_em_pmd", E1000EM) \
89 _ ("rte_igb_pmd", IGB) \
90 _ ("rte_igbvf_pmd", IGBVF) \
91 _ ("rte_ixgbe_pmd", IXGBE) \
92 _ ("rte_ixgbevf_pmd", IXGBEVF) \
93 _ ("rte_i40e_pmd", I40E) \
94 _ ("rte_i40evf_pmd", I40EVF) \
95 _ ("rte_virtio_pmd", VIRTIO) \
96 _ ("rte_enic_pmd", ENIC) \
97 _ ("rte_vmxnet3_pmd", VMXNET3) \
98 _ ("AF_PACKET PMD", AF_PACKET) \
99 _ ("rte_bond_pmd", BOND) \
100 _ ("rte_pmd_fm10k", FM10K) \
101 _ ("rte_cxgbe_pmd", CXGBE) \
102 _ ("rte_dpaa2_dpni", DPAA2)
107 #define _(s,f) VNET_DPDK_PMD_##f,
110 VNET_DPDK_PMD_UNKNOWN, /* must be last */
115 VNET_DPDK_PORT_TYPE_ETH_1G,
116 VNET_DPDK_PORT_TYPE_ETH_10G,
117 VNET_DPDK_PORT_TYPE_ETH_40G,
118 VNET_DPDK_PORT_TYPE_ETH_BOND,
119 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
120 VNET_DPDK_PORT_TYPE_AF_PACKET,
121 VNET_DPDK_PORT_TYPE_UNKNOWN,
130 #define DPDK_EFD_MAX_DISCARD_RATE 10
137 u32 consec_full_frames_cnt;
142 u32 total_packet_cnt;
153 u32 n_since_last_int;
165 char sock_filename[256];
172 dpdk_vu_vring vrings[VHOST_MAX_QUEUE_PAIRS * 2];
173 u64 region_addr[VHOST_MEMORY_MAX_NREGIONS];
174 u32 region_fd[VHOST_MEMORY_MAX_NREGIONS];
175 u64 region_offset[VHOST_MEMORY_MAX_NREGIONS];
179 typedef void (*dpdk_flowcontrol_callback_t) (vlib_main_t * vm,
180 u32 hw_if_index, u32 n_packets);
183 * The header for the tx_vector in dpdk_device_t.
184 * Head and tail are indexes into the tx_vector and are of type
185 * u64 so they never overflow.
195 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
196 volatile u32 **lockp;
201 u32 vlib_hw_if_index;
202 u32 vlib_sw_if_index;
204 /* next node index if we decide to steal the rx graph arc */
205 u32 per_interface_next_index;
207 /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
208 struct rte_mbuf ***tx_vectors; /* one per worker thread */
209 struct rte_mbuf ***rx_vectors;
211 /* vector of traced contexts, per device */
212 u32 *d_trace_buffers;
214 /* number of sub-interfaces */
217 dpdk_device_type_t dev_type:8;
222 #define DPDK_DEVICE_FLAG_ADMIN_UP (1 << 0)
223 #define DPDK_DEVICE_FLAG_PROMISC (1 << 1)
225 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
227 u8 *interface_name_suffix;
234 u16 *cpu_socket_id_by_queue;
235 struct rte_eth_conf port_conf;
236 struct rte_eth_txconf tx_conf;
243 /* vhost-user related */
245 struct virtio_net vu_vhost_dev;
247 dpdk_vu_intf_t *vu_intf;
251 u8 af_packet_port_id;
253 struct rte_eth_link link;
254 f64 time_last_link_update;
256 struct rte_eth_stats stats;
257 struct rte_eth_stats last_stats;
258 struct rte_eth_stats last_cleared_stats;
259 #if RTE_VERSION >= RTE_VERSION_NUM(16, 7, 0, 0)
260 struct rte_eth_xstat *xstats;
261 struct rte_eth_xstat *last_cleared_xstats;
263 struct rte_eth_xstats *xstats;
264 struct rte_eth_xstats *last_cleared_xstats;
266 f64 time_last_stats_update;
267 dpdk_port_type_t port_type;
269 dpdk_efd_agent_t efd_agent;
270 u8 need_txlock; /* Used by VNET_DPDK_DEV_VHOST_USER */
274 #define DPDK_TX_RING_SIZE (4 * 1024)
276 #define DPDK_STATS_POLL_INTERVAL (10.0)
277 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
279 #define DPDK_LINK_POLL_INTERVAL (3.0)
280 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
284 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
286 /* total input packet counter */
287 u64 aggregate_rx_packets;
294 } dpdk_device_and_queue_t;
296 /* Early-Fast-Discard (EFD) */
297 #define DPDK_EFD_DISABLED 0
298 #define DPDK_EFD_DISCARD_ENABLED (1 << 0)
299 #define DPDK_EFD_MONITOR_ENABLED (1 << 1)
300 #define DPDK_EFD_DROPALL_ENABLED (1 << 2)
302 #define DPDK_EFD_DEFAULT_DEVICE_QUEUE_HI_THRESH_PCT 90
303 #define DPDK_EFD_DEFAULT_CONSEC_FULL_FRAMES_HI_THRESH 6
305 typedef struct dpdk_efd_t
309 u16 consec_full_frames_hi_thresh;
313 #define foreach_dpdk_device_config_item \
322 vlib_pci_addr_t pci_addr;
324 u8 vlan_strip_offload;
325 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
326 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
327 #define DPDK_DEVICE_VLAN_STRIP_ON 2
329 #define _(x) uword x;
330 foreach_dpdk_device_config_item
332 clib_bitmap_t * workers;
333 } dpdk_device_config_t;
340 u8 *eal_init_args_str;
343 u8 enable_tcp_udp_checksum;
345 /* Required config parameters */
346 u8 coremask_set_manually;
347 u8 nchannels_set_manually;
351 u8 num_kni; /* while kni_init allows u32, port_id in callback fn is only u8 */
354 * format interface names ala xxxEthernet%d/%d/%d instead of
355 * xxxEthernet%x/%x/%x.
357 u8 interface_name_format_decimal;
359 /* virtio vhost-user switch */
362 /* vhost-user coalescence frames config */
363 u32 vhost_coalesce_frames;
364 f64 vhost_coalesce_time;
366 /* per-device config */
367 dpdk_device_config_t default_devconf;
368 dpdk_device_config_t *dev_confs;
369 uword *device_config_index_by_pci_addr;
371 } dpdk_config_main_t;
373 dpdk_config_main_t dpdk_config_main;
379 dpdk_device_t *devices;
380 dpdk_device_and_queue_t **devices_by_cpu;
382 /* per-thread recycle lists */
385 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
386 u32 buffer_flags_template;
388 /* flow control callback. If 0 then flow control is disabled */
389 dpdk_flowcontrol_callback_t flowcontrol_callback;
391 /* vlib buffer free list, must be same size as an rte_mbuf */
392 u32 vlib_buffer_free_list_index;
394 /* dpdk worker "threads" */
395 dpdk_worker_t *workers;
398 /* Ethernet input node index */
399 u32 ethernet_input_node_index;
401 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
403 pcap_main_t pcap_main;
405 u32 pcap_sw_if_index;
406 u32 pcap_pkts_to_capture;
409 uword *dpdk_device_by_kni_port_id;
410 uword *vu_sw_if_index_by_listener_fd;
411 uword *vu_sw_if_index_by_sock_fd;
412 u32 *vu_inactive_interfaces_device_index;
416 /* efd (early-fast-discard) settings */
420 * flag indicating that a posted admin up/down
421 * (via post_sw_interface_set_flags) is in progress
423 u8 admin_up_down_in_progress;
427 /* which cpus are running dpdk-input */
428 int input_cpu_first_index;
431 /* control interval of dpdk link state and stat polling */
432 f64 link_state_poll_interval;
433 f64 stat_poll_interval;
435 /* Sleep for this many MS after each device poll */
439 vlib_main_t *vlib_main;
440 vnet_main_t *vnet_main;
441 dpdk_config_main_t *conf;
444 dpdk_main_t dpdk_main;
448 DPDK_RX_NEXT_IP4_INPUT,
449 DPDK_RX_NEXT_IP6_INPUT,
450 DPDK_RX_NEXT_MPLS_INPUT,
451 DPDK_RX_NEXT_ETHERNET_INPUT,
462 /* Copy of VLIB buffer; packet data stored in pre_data. */
463 vlib_buffer_t buffer;
464 } dpdk_tx_dma_trace_t;
472 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
473 u8 data[256]; /* First 256 data bytes, used for hexdump */
474 } dpdk_rx_dma_trace_t;
476 void vnet_buffer_needs_dpdk_mb (vlib_buffer_t * b);
478 void dpdk_set_next_node (dpdk_rx_next_t, char *);
480 clib_error_t *dpdk_set_mac_address (vnet_hw_interface_t * hi, char *address);
482 clib_error_t *dpdk_set_mc_filter (vnet_hw_interface_t * hi,
483 struct ether_addr mc_addr_vec[], int naddr);
485 void dpdk_thread_input (dpdk_main_t * dm, dpdk_device_t * xd);
487 clib_error_t *dpdk_port_setup (dpdk_main_t * dm, dpdk_device_t * xd);
489 void dpdk_set_flowcontrol_callback (vlib_main_t * vm,
490 dpdk_flowcontrol_callback_t callback);
492 u32 dpdk_interface_tx_vector (vlib_main_t * vm, u32 dev_instance);
494 void set_efd_bitmap (u8 * bitmap, u32 value, u32 op);
496 struct rte_mbuf *dpdk_replicate_packet_mb (vlib_buffer_t * b);
497 struct rte_mbuf *dpdk_zerocopy_replicate_packet_mb (vlib_buffer_t * b);
499 #define foreach_dpdk_error \
500 _(NONE, "no error") \
501 _(RX_PACKET_ERROR, "Rx packet errors") \
502 _(RX_BAD_FCS, "Rx bad fcs") \
503 _(L4_CHECKSUM_ERROR, "Rx L4 checksum errors") \
504 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
505 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
506 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
507 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error") \
508 _(IPV4_EFD_DROP_PKTS, "IPV4 Early Fast Discard rx drops") \
509 _(IPV6_EFD_DROP_PKTS, "IPV6 Early Fast Discard rx drops") \
510 _(MPLS_EFD_DROP_PKTS, "MPLS Early Fast Discard rx drops") \
511 _(VLAN_EFD_DROP_PKTS, "VLAN Early Fast Discard rx drops")
515 #define _(f,s) DPDK_ERROR_##f,
522 * Increment EFD drop counter
524 static_always_inline void
525 increment_efd_drop_counter (vlib_main_t * vm, u32 counter_index, u32 count)
529 my_n = vlib_get_node (vm, dpdk_input_node.index);
530 vm->error_main.counters[my_n->error_heap_index + counter_index] += count;
533 int dpdk_set_stat_poll_interval (f64 interval);
534 int dpdk_set_link_state_poll_interval (f64 interval);
535 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
536 void dpdk_device_lock_init (dpdk_device_t * xd);
537 void dpdk_device_lock_free (dpdk_device_t * xd);
538 void dpdk_efd_update_counters (dpdk_device_t * xd, u32 n_buffers,
540 u32 is_efd_discardable (vlib_thread_main_t * tm, vlib_buffer_t * b0,
541 struct rte_mbuf *mb);
544 /* dpdk vhost-user interrupt management */
545 u8 dpdk_vhost_user_want_interrupt (dpdk_device_t * xd, int idx);
546 void dpdk_vhost_user_send_interrupt (vlib_main_t * vm, dpdk_device_t * xd,
552 vnet_get_aggregate_rx_packets (void)
554 dpdk_main_t *dm = &dpdk_main;
558 vec_foreach (dw, dm->workers) sum += dw->aggregate_rx_packets;
563 void dpdk_rx_trace (dpdk_main_t * dm,
564 vlib_node_runtime_t * node,
566 u16 queue_id, u32 * buffers, uword n_buffers);
568 #define EFD_OPERATION_LESS_THAN 0
569 #define EFD_OPERATION_GREATER_OR_EQUAL 1
571 void efd_config (u32 enabled,
572 u32 ip_prec, u32 ip_op,
573 u32 mpls_exp, u32 mpls_op, u32 vlan_cos, u32 vlan_op);
575 void post_sw_interface_set_flags (vlib_main_t * vm, u32 sw_if_index,
579 typedef struct vhost_user_memory vhost_user_memory_t;
581 void dpdk_vhost_user_process_init (void **ctx);
582 void dpdk_vhost_user_process_cleanup (void *ctx);
583 uword dpdk_vhost_user_process_if (vlib_main_t * vm, dpdk_device_t * xd,
587 int dpdk_vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
588 const char *sock_filename,
592 u8 renumber, u32 custom_dev_instance,
594 int dpdk_vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
595 const char *sock_filename,
599 u8 renumber, u32 custom_dev_instance);
600 int dpdk_vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
602 int dpdk_vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
603 vhost_user_intf_details_t ** out_vuids);
606 u32 dpdk_get_admin_up_down_in_progress (void);
608 u32 dpdk_num_mbufs (void);
610 dpdk_pmd_t dpdk_get_pmd_type (vnet_hw_interface_t * hi);
612 i8 dpdk_get_cpu_socket (vnet_hw_interface_t * hi);
614 void *dpdk_input_multiarch_select ();
615 void *dpdk_input_rss_multiarch_select ();
616 void *dpdk_input_efd_multiarch_select ();
618 clib_error_t *dpdk_get_hw_interface_stats (u32 hw_if_index,
619 struct rte_eth_stats *dest);
621 format_function_t format_dpdk_device_name;
622 format_function_t format_dpdk_device;
623 format_function_t format_dpdk_tx_dma_trace;
624 format_function_t format_dpdk_rx_dma_trace;
625 format_function_t format_dpdk_rte_mbuf;
626 format_function_t format_dpdk_rx_rte_mbuf;
627 unformat_function_t unformat_socket_mem;
628 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
632 dpdk_pmd_constructor_init ()
634 /* Add references to DPDK Driver Constructor functions to get the dynamic
635 * loader to pull in the driver library & run the constructors.
639 void devinitfn_ ##d(void); \
640 __attribute__((unused)) void (* volatile pf)(void); \
641 pf = devinitfn_ ##d; \
644 #ifdef RTE_LIBRTE_EM_PMD
647 #ifdef RTE_LIBRTE_IGB_PMD
650 #ifdef RTE_LIBRTE_IXGBE_PMD
653 #ifdef RTE_LIBRTE_I40E_PMD
654 _(rte_i40e_driver) _(rte_i40evf_driver)
656 #ifdef RTE_LIBRTE_FM10K_PMD
659 #ifdef RTE_LIBRTE_VIRTIO_PMD
662 #ifdef RTE_LIBRTE_VMXNET3_PMD
663 _(rte_vmxnet3_driver)
665 #ifdef RTE_LIBRTE_VICE_PMD
668 #ifdef RTE_LIBRTE_ENIC_PMD
671 #ifdef RTE_LIBRTE_PMD_AF_PACKET
674 #ifdef RTE_LIBRTE_CXGBE_PMD
677 #ifdef RTE_LIBRTE_PMD_BOND
680 #ifdef RTE_LIBRTE_DPAA2_PMD
685 * At the moment, the ThunderX NIC driver doesn't have
686 * an entry point named "devinitfn_rte_xxx_driver"
691 __attribute__((unused)) void (* volatile pf)(void); \
694 #ifdef RTE_LIBRTE_THUNDERVNIC_PMD
695 _(rte_nicvf_pmd_init)
701 admin_up_down_process (vlib_main_t * vm,
702 vlib_node_runtime_t * rt, vlib_frame_t * f);
704 #endif /* __included_dpdk_h__ */
707 * fd.io coding-style-patch-verification: ON
710 * eval: (c-set-style "gnu")