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 #define ALLOW_EXPERIMENTAL_API
23 #include <rte_config.h>
26 #include <rte_bus_pci.h>
27 #include <rte_bus_vmbus.h>
28 #include <rte_ethdev.h>
29 #include <rte_version.h>
32 #include <vnet/devices/devices.h>
35 #define always_inline static inline
37 #define always_inline static inline __attribute__ ((__always_inline__))
40 #include <vlib/pci/pci.h>
41 #include <vlib/vmbus/vmbus.h>
42 #include <vnet/flow/flow.h>
44 extern vnet_device_class_t dpdk_device_class;
45 extern vlib_node_registration_t dpdk_input_node;
46 extern vlib_node_registration_t admin_up_down_process_node;
48 #if RTE_VERSION < RTE_VERSION_NUM(20, 8, 0, 0)
49 #define DPDK_MLX5_PMD_NAME "net_mlx5"
51 #define DPDK_MLX5_PMD_NAME "mlx5_pci"
54 #define foreach_dpdk_pmd \
55 _ ("net_thunderx", THUNDERX) \
56 _ ("net_e1000_em", E1000EM) \
57 _ ("net_e1000_igb", IGB) \
58 _ ("net_e1000_igb_vf", IGBVF) \
59 _ ("net_ixgbe", IXGBE) \
60 _ ("net_ixgbe_vf", IXGBEVF) \
61 _ ("net_i40e", I40E) \
62 _ ("net_i40e_vf", I40EVF) \
64 _ ("net_iavf", IAVF) \
66 _ ("net_virtio", VIRTIO) \
67 _ ("net_enic", ENIC) \
68 _ ("net_vmxnet3", VMXNET3) \
69 _ ("AF_PACKET PMD", AF_PACKET) \
70 _ ("net_fm10k", FM10K) \
71 _ ("net_cxgbe", CXGBE) \
72 _ ("net_mlx4", MLX4) \
73 _ (DPDK_MLX5_PMD_NAME, MLX5) \
74 _ ("net_dpaa2", DPAA2) \
75 _ ("net_virtio_user", VIRTIO_USER) \
76 _ ("net_vhost", VHOST_ETHER) \
78 _ ("net_failsafe", FAILSAFE) \
79 _ ("net_liovf", LIOVF_ETHER) \
80 _ ("net_qede", QEDE) \
81 _ ("net_netvsc", NETVSC) \
87 #define _(s,f) VNET_DPDK_PMD_##f,
90 VNET_DPDK_PMD_UNKNOWN, /* must be last */
95 VNET_DPDK_PORT_TYPE_ETH_1G,
96 VNET_DPDK_PORT_TYPE_ETH_2_5G,
97 VNET_DPDK_PORT_TYPE_ETH_5G,
98 VNET_DPDK_PORT_TYPE_ETH_10G,
99 VNET_DPDK_PORT_TYPE_ETH_20G,
100 VNET_DPDK_PORT_TYPE_ETH_25G,
101 VNET_DPDK_PORT_TYPE_ETH_40G,
102 VNET_DPDK_PORT_TYPE_ETH_50G,
103 VNET_DPDK_PORT_TYPE_ETH_56G,
104 VNET_DPDK_PORT_TYPE_ETH_100G,
105 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
106 VNET_DPDK_PORT_TYPE_AF_PACKET,
107 VNET_DPDK_PORT_TYPE_ETH_VF,
108 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
109 VNET_DPDK_PORT_TYPE_VHOST_ETHER,
110 VNET_DPDK_PORT_TYPE_FAILSAFE,
111 VNET_DPDK_PORT_TYPE_NETVSC,
112 VNET_DPDK_PORT_TYPE_UNKNOWN,
115 typedef uint16_t dpdk_portid_t;
117 #define foreach_dpdk_device_flags \
118 _ (0, ADMIN_UP, "admin-up") \
119 _ (1, PROMISC, "promisc") \
121 _ (3, PMD_INIT_FAIL, "pmd-init-fail") \
122 _ (4, MAYBE_MULTISEG, "maybe-multiseg") \
123 _ (5, HAVE_SUBIF, "subif") \
124 _ (9, TX_OFFLOAD, "tx-offload") \
125 _ (10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
126 _ (11, RX_FLOW_OFFLOAD, "rx-flow-offload") \
127 _ (12, RX_IP4_CKSUM, "rx-ip4-cksum") \
128 _ (13, INT_SUPPORTED, "int-supported") \
129 _ (14, INT_UNMASKABLE, "int-unmaskable")
133 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
134 foreach_dpdk_device_flags
142 struct rte_flow *handle;
150 } dpdk_flow_lookup_entry_t;
154 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
155 u8 buffer_pool_index;
158 uword clib_file_index;
163 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
164 clib_spinlock_t lock;
169 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
171 dpdk_rx_queue_t *rx_queues;
172 dpdk_tx_queue_t *tx_queues;
174 /* Instance ID to access internal device array. */
181 /* next node index if we decide to steal the rx graph arc */
182 u32 per_interface_next_index;
188 /* DPDK device port number */
189 dpdk_portid_t port_id;
193 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
198 u8 *interface_name_suffix;
200 /* number of sub-interfaces */
204 struct rte_eth_conf port_conf;
205 struct rte_eth_txconf tx_conf;
208 u32 supported_flow_actions;
209 dpdk_flow_entry_t *flow_entries; /* pool */
210 dpdk_flow_lookup_entry_t *flow_lookup_entries; /* pool */
211 u32 *parked_lookup_indexes; /* vector */
212 u32 parked_loop_count;
213 struct rte_flow_error last_flow_error;
215 /* af_packet instance number */
216 u16 af_packet_instance_num;
218 struct rte_eth_link link;
219 f64 time_last_link_update;
221 struct rte_eth_stats stats;
222 struct rte_eth_stats last_stats;
223 struct rte_eth_xstat *xstats;
224 f64 time_last_stats_update;
225 dpdk_port_type_t port_type;
228 u8 *default_mac_address;
231 clib_error_t *errors;
234 #define DPDK_STATS_POLL_INTERVAL (10.0)
235 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
237 #define DPDK_LINK_POLL_INTERVAL (3.0)
238 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
240 #define foreach_dpdk_device_config_item \
245 _ (max_lro_pkt_size) \
253 } dpdk_device_addr_type_t;
259 vlib_pci_addr_t pci_addr;
260 vlib_vmbus_addr_t vmbus_addr;
262 dpdk_device_addr_type_t dev_addr_type;
266 #define _(x) uword x;
267 foreach_dpdk_device_config_item
269 clib_bitmap_t * workers;
272 clib_bitmap_t *rss_queues;
274 #define DPDK_DEVICE_TSO_DEFAULT 0
275 #define DPDK_DEVICE_TSO_OFF 1
276 #define DPDK_DEVICE_TSO_ON 2
277 } dpdk_device_config_t;
284 u8 *eal_init_args_str;
288 u8 enable_tcp_udp_checksum;
289 u8 enable_outer_checksum_offload;
290 u8 no_tx_checksum_offload;
292 u16 max_simd_bitwidth;
294 #define DPDK_MAX_SIMD_BITWIDTH_DEFAULT 0
295 #define DPDK_MAX_SIMD_BITWIDTH_256 256
296 #define DPDK_MAX_SIMD_BITWIDTH_512 512
299 * format interface names ala xxxEthernet%d/%d/%d instead of
300 * xxxEthernet%x/%x/%x.
302 u8 interface_name_format_decimal;
304 /* per-device config */
305 dpdk_device_config_t default_devconf;
306 dpdk_device_config_t *dev_confs;
307 uword *device_config_index_by_pci_addr;
308 mhash_t device_config_index_by_vmbus_addr;
310 /* devices blacklist by pci vendor_id, device_id */
311 u32 *blacklist_by_pci_vendor_and_device;
312 /* devices blacklist by VMBUS address */
313 vlib_vmbus_addr_t *blacklist_by_vmbus_addr;
315 } dpdk_config_main_t;
317 extern dpdk_config_main_t dpdk_config_main;
319 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
323 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
324 struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
325 u32 buffers[DPDK_RX_BURST_SZ];
326 u16 next[DPDK_RX_BURST_SZ];
327 u16 etype[DPDK_RX_BURST_SZ];
328 u32 flags[DPDK_RX_BURST_SZ];
329 vlib_buffer_t buffer_template;
330 } dpdk_per_thread_data_t;
335 dpdk_device_t *devices;
336 dpdk_per_thread_data_t *per_thread_data;
339 * flag indicating that a posted admin up/down
340 * (via post_sw_interface_set_flags) is in progress
342 u8 admin_up_down_in_progress;
344 /* control interval of dpdk link state and stat polling */
345 f64 link_state_poll_interval;
346 f64 stat_poll_interval;
348 dpdk_config_main_t *conf;
350 /* API message ID base */
354 vlib_log_class_t log_default;
355 vlib_log_class_t log_cryptodev;
358 extern dpdk_main_t dpdk_main;
366 u8 data[256]; /* First 256 data bytes, used for hexdump */
367 /* Copy of VLIB buffer; packet data stored in pre_data. */
368 vlib_buffer_t buffer;
377 u8 data[256]; /* First 256 data bytes, used for hexdump */
378 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
381 void dpdk_device_setup (dpdk_device_t * xd);
382 void dpdk_device_start (dpdk_device_t * xd);
383 void dpdk_device_stop (dpdk_device_t * xd);
384 int dpdk_port_state_callback (dpdk_portid_t port_id,
385 enum rte_eth_event_type type,
386 void *param, void *ret_param);
388 #define foreach_dpdk_error \
389 _(NONE, "no error") \
390 _(RX_PACKET_ERROR, "Rx packet errors") \
391 _(RX_BAD_FCS, "Rx bad fcs") \
392 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
393 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
394 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
395 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
399 #define _(f,s) DPDK_ERROR_##f,
405 #define dpdk_log_err(...) \
406 vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
407 #define dpdk_log_warn(...) \
408 vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
409 #define dpdk_log_notice(...) \
410 vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
411 #define dpdk_log_info(...) \
412 vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
414 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
416 #define foreach_dpdk_rss_hf \
417 _ (0, ETH_RSS_FRAG_IPV4, "ipv4-frag") \
418 _ (1, ETH_RSS_NONFRAG_IPV4_TCP, "ipv4-tcp") \
419 _ (2, ETH_RSS_NONFRAG_IPV4_UDP, "ipv4-udp") \
420 _ (3, ETH_RSS_NONFRAG_IPV4_SCTP, "ipv4-sctp") \
421 _ (4, ETH_RSS_NONFRAG_IPV4_OTHER, "ipv4-other") \
422 _ (5, ETH_RSS_IPV4, "ipv4") \
423 _ (6, ETH_RSS_IPV6_TCP_EX, "ipv6-tcp-ex") \
424 _ (7, ETH_RSS_IPV6_UDP_EX, "ipv6-udp-ex") \
425 _ (8, ETH_RSS_FRAG_IPV6, "ipv6-frag") \
426 _ (9, ETH_RSS_NONFRAG_IPV6_TCP, "ipv6-tcp") \
427 _ (10, ETH_RSS_NONFRAG_IPV6_UDP, "ipv6-udp") \
428 _ (11, ETH_RSS_NONFRAG_IPV6_SCTP, "ipv6-sctp") \
429 _ (12, ETH_RSS_NONFRAG_IPV6_OTHER, "ipv6-other") \
430 _ (13, ETH_RSS_IPV6_EX, "ipv6-ex") \
431 _ (14, ETH_RSS_IPV6, "ipv6") \
432 _ (15, ETH_RSS_L2_PAYLOAD, "l2-payload") \
433 _ (16, ETH_RSS_PORT, "port") \
434 _ (17, ETH_RSS_VXLAN, "vxlan") \
435 _ (18, ETH_RSS_GENEVE, "geneve") \
436 _ (19, ETH_RSS_NVGRE, "nvgre") \
437 _ (20, ETH_RSS_GTPU, "gtpu") \
438 _ (21, ETH_RSS_ESP, "esp") \
439 _ (60, ETH_RSS_L4_DST_ONLY, "l4-dst-only") \
440 _ (61, ETH_RSS_L4_SRC_ONLY, "l4-src-only") \
441 _ (62, ETH_RSS_L3_DST_ONLY, "l3-dst-only") \
442 _ (63, ETH_RSS_L3_SRC_ONLY, "l3-src-only")
444 format_function_t format_dpdk_device_name;
445 format_function_t format_dpdk_device;
446 format_function_t format_dpdk_device_errors;
447 format_function_t format_dpdk_tx_trace;
448 format_function_t format_dpdk_rx_trace;
449 format_function_t format_dpdk_rte_mbuf;
450 format_function_t format_dpdk_rx_rte_mbuf;
451 format_function_t format_dpdk_flow;
452 format_function_t format_dpdk_rss_hf_name;
453 format_function_t format_dpdk_rx_offload_caps;
454 format_function_t format_dpdk_tx_offload_caps;
455 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
457 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
459 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
461 struct rte_vmbus_device *
462 dpdk_get_vmbus_device (const struct rte_eth_dev_info *info);
463 void dpdk_cli_reference (void);
466 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
467 void dpdk_buffer_poison_trajectory_all (void);
470 #endif /* __included_dpdk_h__ */
473 * fd.io coding-style-patch-verification: ON
476 * eval: (c-set-style "gnu")