/* * Copyright (c) 2015 Cisco and/or its affiliates. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef __included_dpdk_h__ #define __included_dpdk_h__ /* $$$$ We should rename always_inline -> clib_always_inline */ #undef always_inline #define ALLOW_EXPERIMENTAL_API #include #include #include #ifdef __linux__ #include #endif /* __linux__ */ #include #include #include #if RTE_VERSION >= RTE_VERSION_NUM(22, 11, 0, 0) #include #include #include #include #include #ifdef __linux__ #include #endif /* __linux__ */ #endif #include #if CLIB_DEBUG > 0 #define always_inline static inline #else #define always_inline static inline __attribute__ ((__always_inline__)) #endif #include #include #include extern vnet_device_class_t dpdk_device_class; extern vlib_node_registration_t dpdk_input_node; extern vlib_node_registration_t admin_up_down_process_node; typedef uint16_t dpdk_portid_t; #define foreach_dpdk_device_flags \ _ (0, ADMIN_UP, "admin-up") \ _ (1, PROMISC, "promisc") \ _ (3, PMD_INIT_FAIL, "pmd-init-fail") \ _ (4, MAYBE_MULTISEG, "maybe-multiseg") \ _ (5, HAVE_SUBIF, "subif") \ _ (9, TX_OFFLOAD, "tx-offload") \ _ (10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \ _ (11, RX_FLOW_OFFLOAD, "rx-flow-offload") \ _ (12, RX_IP4_CKSUM, "rx-ip4-cksum") \ _ (13, INT_SUPPORTED, "int-supported") \ _ (14, INT_UNMASKABLE, "int-unmaskable") typedef enum { #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a), foreach_dpdk_device_flags #undef _ } dpdk_device_flag_t; typedef struct { u32 flow_index; u32 mark; struct rte_flow *handle; } dpdk_flow_entry_t; typedef struct { u32 flow_id; u16 next_index; i16 buffer_advance; } dpdk_flow_lookup_entry_t; typedef struct { CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); u8 buffer_pool_index; u32 queue_index; int efd; uword clib_file_index; } dpdk_rx_queue_t; typedef struct { CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); clib_spinlock_t lock; u32 queue_index; } dpdk_tx_queue_t; typedef struct { const char *name; const char *desc; } dpdk_driver_name_t; typedef struct { dpdk_driver_name_t *drivers; const char *interface_name_prefix; u16 n_rx_desc; u16 n_tx_desc; u32 supported_flow_actions; u32 enable_lsc_int : 1; u32 enable_rxq_int : 1; u32 disable_rx_scatter : 1; u32 program_vlans : 1; u32 mq_mode_none : 1; u32 interface_number_from_port_id : 1; u32 use_intel_phdr_cksum : 1; u32 int_unmaskable : 1; } dpdk_driver_t; dpdk_driver_t *dpdk_driver_find (const char *name, const char **desc); typedef union { struct { u16 disable_multi_seg : 1; u16 enable_lro : 1; u16 enable_tso : 1; u16 enable_tcp_udp_checksum : 1; u16 enable_outer_checksum_offload : 1; u16 enable_lsc_int : 1; u16 enable_rxq_int : 1; u16 disable_tx_checksum_offload : 1; u16 disable_rss : 1; u16 disable_rx_scatter : 1; u16 n_rx_queues; u16 n_tx_queues; u16 n_rx_desc; u16 n_tx_desc; u32 max_lro_pkt_size; u64 rss_hf; }; u64 as_u64[3]; } dpdk_port_conf_t; STATIC_ASSERT_SIZEOF (dpdk_port_conf_t, 24); typedef struct { CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); dpdk_rx_queue_t *rx_queues; dpdk_tx_queue_t *tx_queues; /* Instance ID to access internal device array. */ u32 device_index; u32 hw_if_index; u32 sw_if_index; u32 buffer_flags; /* next node index if we decide to steal the rx graph arc */ u32 per_interface_next_index; u16 flags; /* DPDK device port number */ dpdk_portid_t port_id; i8 cpu_socket; CLIB_CACHE_LINE_ALIGN_MARK (cacheline1); u64 enabled_tx_off; u64 enabled_rx_off; dpdk_driver_t *driver; u8 *name; const char *if_desc; /* number of sub-interfaces */ u16 num_subifs; /* flow related */ u32 supported_flow_actions; dpdk_flow_entry_t *flow_entries; /* pool */ dpdk_flow_lookup_entry_t *flow_lookup_entries; /* pool */ u32 *parked_lookup_indexes; /* vector */ u32 parked_loop_count; struct rte_flow_error last_flow_error; struct rte_eth_link link; f64 time_last_link_update; struct rte_eth_stats stats; struct rte_eth_stats last_stats; struct rte_eth_xstat *xstats; f64 time_last_stats_update; /* mac address */ u8 *default_mac_address; /* maximum supported max frame size */ u32 max_supported_frame_size; /* due to lack of API to get ethernet max_frame_size we store information * deducted from device info */ u8 driver_frame_overhead; /* error string */ clib_error_t *errors; dpdk_port_conf_t conf; } dpdk_device_t; #define DPDK_MIN_POLL_INTERVAL (0.001) /* 1msec */ #define DPDK_STATS_POLL_INTERVAL (10.0) #define DPDK_MIN_STATS_POLL_INTERVAL DPDK_MIN_POLL_INTERVAL #define DPDK_LINK_POLL_INTERVAL (3.0) #define DPDK_MIN_LINK_POLL_INTERVAL DPDK_MIN_POLL_INTERVAL #define foreach_dpdk_device_config_item \ _ (num_rx_queues) \ _ (num_tx_queues) \ _ (num_rx_desc) \ _ (num_tx_desc) \ _ (max_lro_pkt_size) \ _ (rss_fn) typedef enum { VNET_DEV_ADDR_PCI, VNET_DEV_ADDR_VMBUS, VNET_DEV_ADDR_ANY, } dpdk_device_addr_type_t; typedef struct { union { vlib_pci_addr_t pci_addr; vlib_vmbus_addr_t vmbus_addr; }; dpdk_device_addr_type_t dev_addr_type; u8 *name; u8 *tag; u8 is_blacklisted; #define _(x) uword x; foreach_dpdk_device_config_item #undef _ clib_bitmap_t * workers; u8 tso; u8 *devargs; clib_bitmap_t *rss_queues; #define DPDK_DEVICE_TSO_DEFAULT 0 #define DPDK_DEVICE_TSO_OFF 1 #define DPDK_DEVICE_TSO_ON 2 } dpdk_device_config_t; typedef struct { /* Config stuff */ u8 **eal_init_args; u8 *eal_init_args_str; u8 *uio_driver_name; u8 uio_bind_force; u8 enable_telemetry; u16 max_simd_bitwidth; #define DPDK_MAX_SIMD_BITWIDTH_DEFAULT 0 #define DPDK_MAX_SIMD_BITWIDTH_256 256 #define DPDK_MAX_SIMD_BITWIDTH_512 512 /* * format interface names ala xxxEthernet%d/%d/%d instead of * xxxEthernet%x/%x/%x. */ u8 interface_name_format_decimal; /* per-device config */ dpdk_device_config_t default_devconf; dpdk_device_config_t *dev_confs; uword *device_config_index_by_pci_addr; mhash_t device_config_index_by_vmbus_addr; /* devices blacklist by pci vendor_id, device_id */ u32 *blacklist_by_pci_vendor_and_device; /* devices blacklist by VMBUS address */ vlib_vmbus_addr_t *blacklist_by_vmbus_addr; } dpdk_config_main_t; extern dpdk_config_main_t dpdk_config_main; #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE typedef struct { CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ]; u32 buffers[DPDK_RX_BURST_SZ]; u16 next[DPDK_RX_BURST_SZ]; u16 etype[DPDK_RX_BURST_SZ]; u32 flags[DPDK_RX_BURST_SZ]; vlib_buffer_t buffer_template; } dpdk_per_thread_data_t; typedef struct { /* Devices */ dpdk_device_t *devices; dpdk_per_thread_data_t *per_thread_data; /* * flag indicating that a posted admin up/down * (via post_sw_interface_set_flags) is in progress */ u8 admin_up_down_in_progress; /* control interval of dpdk link state and stat polling */ f64 link_state_poll_interval; f64 stat_poll_interval; dpdk_config_main_t *conf; dpdk_port_conf_t default_port_conf; /* API message ID base */ u16 msg_id_base; /* logging */ vlib_log_class_t log_default; vlib_log_class_t log_cryptodev; } dpdk_main_t; extern dpdk_main_t dpdk_main; typedef struct { u32 buffer_index; u16 device_index; u8 queue_index; struct rte_mbuf mb; u8 data[256]; /* First 256 data bytes, used for hexdump */ /* Copy of VLIB buffer; packet data stored in pre_data. */ vlib_buffer_t buffer; } dpdk_tx_trace_t; typedef struct { u32 buffer_index; u16 device_index; u16 queue_index; struct rte_mbuf mb; u8 data[256]; /* First 256 data bytes, used for hexdump */ vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */ } dpdk_rx_trace_t; void dpdk_device_setup (dpdk_device_t * xd); void dpdk_device_start (dpdk_device_t * xd); void dpdk_device_stop (dpdk_device_t * xd); int dpdk_port_state_callback (dpdk_portid_t port_id, enum rte_eth_event_type type, void *param, void *ret_param); #define foreach_dpdk_error \ _(NONE, "no error") \ _(RX_PACKET_ERROR, "Rx packet errors") \ _(RX_BAD_FCS, "Rx bad fcs") \ _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \ _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \ _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \ _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error") typedef enum { #define _(f,s) DPDK_ERROR_##f, foreach_dpdk_error #undef _ DPDK_N_ERROR, } dpdk_error_t; #define dpdk_log_err(...) \ vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__) #define dpdk_log_warn(...) \ vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__) #define dpdk_log_notice(...) \ vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__) #define dpdk_log_info(...) \ vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__) #define dpdk_log_debug(...) \ vlib_log (VLIB_LOG_LEVEL_DEBUG, dpdk_main.log_default, __VA_ARGS__) void dpdk_update_link_state (dpdk_device_t * xd, f64 now); #define foreach_dpdk_rss_hf \ _ (0, RTE_ETH_RSS_FRAG_IPV4, "ipv4-frag") \ _ (1, RTE_ETH_RSS_NONFRAG_IPV4_TCP, "ipv4-tcp") \ _ (2, RTE_ETH_RSS_NONFRAG_IPV4_UDP, "ipv4-udp") \ _ (3, RTE_ETH_RSS_NONFRAG_IPV4_SCTP, "ipv4-sctp") \ _ (4, RTE_ETH_RSS_NONFRAG_IPV4_OTHER, "ipv4-other") \ _ (5, RTE_ETH_RSS_IPV4, "ipv4") \ _ (6, RTE_ETH_RSS_IPV6_TCP_EX, "ipv6-tcp-ex") \ _ (7, RTE_ETH_RSS_IPV6_UDP_EX, "ipv6-udp-ex") \ _ (8, RTE_ETH_RSS_FRAG_IPV6, "ipv6-frag") \ _ (9, RTE_ETH_RSS_NONFRAG_IPV6_TCP, "ipv6-tcp") \ _ (10, RTE_ETH_RSS_NONFRAG_IPV6_UDP, "ipv6-udp") \ _ (11, RTE_ETH_RSS_NONFRAG_IPV6_SCTP, "ipv6-sctp") \ _ (12, RTE_ETH_RSS_NONFRAG_IPV6_OTHER, "ipv6-other") \ _ (13, RTE_ETH_RSS_IPV6_EX, "ipv6-ex") \ _ (14, RTE_ETH_RSS_IPV6, "ipv6") \ _ (15, RTE_ETH_RSS_L2_PAYLOAD, "l2-payload") \ _ (16, RTE_ETH_RSS_PORT, "port") \ _ (17, RTE_ETH_RSS_VXLAN, "vxlan") \ _ (18, RTE_ETH_RSS_GENEVE, "geneve") \ _ (19, RTE_ETH_RSS_NVGRE, "nvgre") \ _ (20, RTE_ETH_RSS_GTPU, "gtpu") \ _ (21, RTE_ETH_RSS_ESP, "esp") \ _ (22, RTE_ETH_RSS_L2TPV3, "l2tpv3") \ _ (60, RTE_ETH_RSS_L4_DST_ONLY, "l4-dst-only") \ _ (61, RTE_ETH_RSS_L4_SRC_ONLY, "l4-src-only") \ _ (62, RTE_ETH_RSS_L3_DST_ONLY, "l3-dst-only") \ _ (63, RTE_ETH_RSS_L3_SRC_ONLY, "l3-src-only") format_function_t format_dpdk_device_name; format_function_t format_dpdk_device; format_function_t format_dpdk_device_errors; format_function_t format_dpdk_tx_trace; format_function_t format_dpdk_rx_trace; format_function_t format_dpdk_rte_mbuf; format_function_t format_dpdk_rx_rte_mbuf; format_function_t format_dpdk_flow; format_function_t format_dpdk_rss_hf_name; format_function_t format_dpdk_rx_offload_caps; format_function_t format_dpdk_tx_offload_caps; format_function_t format_dpdk_burst_fn; format_function_t format_dpdk_rte_device; vnet_flow_dev_ops_function_t dpdk_flow_ops_fn; clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn); struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info *info); struct rte_vmbus_device * dpdk_get_vmbus_device (const struct rte_eth_dev_info *info); void dpdk_cli_reference (void); #if CLI_DEBUG int dpdk_buffer_validate_trajectory_all (u32 * uninitialized); void dpdk_buffer_poison_trajectory_all (void); #endif #endif /* __included_dpdk_h__ */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */