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>
25 #include <rte_common.h>
27 #include <rte_memory.h>
29 #include <rte_per_lcore.h>
30 #include <rte_cycles.h>
31 #include <rte_lcore.h>
32 #include <rte_per_lcore.h>
33 #include <rte_interrupts.h>
35 #include <rte_bus_vmbus.h>
36 #include <rte_ether.h>
37 #include <rte_ethdev.h>
39 #include <rte_mempool.h>
41 #include <rte_version.h>
42 #include <rte_sched.h>
44 #include <rte_bus_pci.h>
47 #include <vnet/devices/devices.h>
50 #define always_inline static inline
52 #define always_inline static inline __attribute__ ((__always_inline__))
55 #include <vlib/pci/pci.h>
56 #include <vlib/vmbus/vmbus.h>
57 #include <vnet/flow/flow.h>
59 extern vnet_device_class_t dpdk_device_class;
60 extern vlib_node_registration_t dpdk_input_node;
61 extern vlib_node_registration_t admin_up_down_process_node;
63 #if RTE_VERSION < RTE_VERSION_NUM(20, 8, 0, 0)
64 #define DPDK_MLX5_PMD_NAME "net_mlx5"
66 #define DPDK_MLX5_PMD_NAME "mlx5_pci"
69 #define foreach_dpdk_pmd \
70 _ ("net_thunderx", THUNDERX) \
71 _ ("net_e1000_em", E1000EM) \
72 _ ("net_e1000_igb", IGB) \
73 _ ("net_e1000_igb_vf", IGBVF) \
74 _ ("net_ixgbe", IXGBE) \
75 _ ("net_ixgbe_vf", IXGBEVF) \
76 _ ("net_i40e", I40E) \
77 _ ("net_i40e_vf", I40EVF) \
79 _ ("net_iavf", IAVF) \
80 _ ("net_virtio", VIRTIO) \
81 _ ("net_enic", ENIC) \
82 _ ("net_vmxnet3", VMXNET3) \
83 _ ("AF_PACKET PMD", AF_PACKET) \
84 _ ("net_fm10k", FM10K) \
85 _ ("net_cxgbe", CXGBE) \
86 _ ("net_mlx4", MLX4) \
87 _ (DPDK_MLX5_PMD_NAME, MLX5) \
88 _ ("net_dpaa2", DPAA2) \
89 _ ("net_virtio_user", VIRTIO_USER) \
90 _ ("net_vhost", VHOST_ETHER) \
92 _ ("net_failsafe", FAILSAFE) \
93 _ ("net_liovf", LIOVF_ETHER) \
94 _ ("net_qede", QEDE) \
95 _ ("net_netvsc", NETVSC) \
101 #define _(s,f) VNET_DPDK_PMD_##f,
104 VNET_DPDK_PMD_UNKNOWN, /* must be last */
109 VNET_DPDK_PORT_TYPE_ETH_1G,
110 VNET_DPDK_PORT_TYPE_ETH_2_5G,
111 VNET_DPDK_PORT_TYPE_ETH_5G,
112 VNET_DPDK_PORT_TYPE_ETH_10G,
113 VNET_DPDK_PORT_TYPE_ETH_20G,
114 VNET_DPDK_PORT_TYPE_ETH_25G,
115 VNET_DPDK_PORT_TYPE_ETH_40G,
116 VNET_DPDK_PORT_TYPE_ETH_50G,
117 VNET_DPDK_PORT_TYPE_ETH_56G,
118 VNET_DPDK_PORT_TYPE_ETH_100G,
119 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
120 VNET_DPDK_PORT_TYPE_AF_PACKET,
121 VNET_DPDK_PORT_TYPE_ETH_VF,
122 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
123 VNET_DPDK_PORT_TYPE_VHOST_ETHER,
124 VNET_DPDK_PORT_TYPE_FAILSAFE,
125 VNET_DPDK_PORT_TYPE_NETVSC,
126 VNET_DPDK_PORT_TYPE_UNKNOWN,
129 typedef uint16_t dpdk_portid_t;
131 #define foreach_dpdk_device_flags \
132 _ (0, ADMIN_UP, "admin-up") \
133 _ (1, PROMISC, "promisc") \
135 _ (3, PMD_INIT_FAIL, "pmd-init-fail") \
136 _ (4, MAYBE_MULTISEG, "maybe-multiseg") \
137 _ (5, HAVE_SUBIF, "subif") \
138 _ (9, TX_OFFLOAD, "tx-offload") \
139 _ (10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
140 _ (11, RX_FLOW_OFFLOAD, "rx-flow-offload") \
141 _ (12, RX_IP4_CKSUM, "rx-ip4-cksum") \
142 _ (13, INT_SUPPORTED, "int-supported")
146 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
147 foreach_dpdk_device_flags
155 struct rte_flow *handle;
163 } dpdk_flow_lookup_entry_t;
167 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
168 u8 buffer_pool_index;
171 uword clib_file_index;
176 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
177 clib_spinlock_t lock;
182 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
184 dpdk_rx_queue_t *rx_queues;
185 dpdk_tx_queue_t *tx_queues;
187 /* Instance ID to access internal device array. */
193 /* next node index if we decide to steal the rx graph arc */
194 u32 per_interface_next_index;
200 /* DPDK device port number */
201 dpdk_portid_t port_id;
205 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
210 u8 *interface_name_suffix;
212 /* number of sub-interfaces */
216 struct rte_eth_conf port_conf;
217 struct rte_eth_txconf tx_conf;
220 u32 supported_flow_actions;
221 dpdk_flow_entry_t *flow_entries; /* pool */
222 dpdk_flow_lookup_entry_t *flow_lookup_entries; /* pool */
223 u32 *parked_lookup_indexes; /* vector */
224 u32 parked_loop_count;
225 struct rte_flow_error last_flow_error;
227 /* af_packet instance number */
228 u16 af_packet_instance_num;
230 struct rte_eth_link link;
231 f64 time_last_link_update;
233 struct rte_eth_stats stats;
234 struct rte_eth_stats last_stats;
235 struct rte_eth_xstat *xstats;
236 f64 time_last_stats_update;
237 dpdk_port_type_t port_type;
240 u8 *default_mac_address;
243 clib_error_t *errors;
246 #define DPDK_STATS_POLL_INTERVAL (10.0)
247 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
249 #define DPDK_LINK_POLL_INTERVAL (3.0)
250 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
252 #define foreach_dpdk_device_config_item \
264 } dpdk_device_addr_type_t;
270 vlib_pci_addr_t pci_addr;
271 vlib_vmbus_addr_t vmbus_addr;
273 dpdk_device_addr_type_t dev_addr_type;
276 u8 vlan_strip_offload;
277 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
278 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
279 #define DPDK_DEVICE_VLAN_STRIP_ON 2
281 #define _(x) uword x;
282 foreach_dpdk_device_config_item
284 clib_bitmap_t * workers;
287 clib_bitmap_t *rss_queues;
289 #define DPDK_DEVICE_TSO_DEFAULT 0
290 #define DPDK_DEVICE_TSO_OFF 1
291 #define DPDK_DEVICE_TSO_ON 2
292 } dpdk_device_config_t;
299 u8 *eal_init_args_str;
302 u8 enable_tcp_udp_checksum;
303 u8 no_tx_checksum_offload;
306 /* Required config parameters */
307 u8 coremask_set_manually;
308 u8 nchannels_set_manually;
311 u32 num_crypto_mbufs;
314 * format interface names ala xxxEthernet%d/%d/%d instead of
315 * xxxEthernet%x/%x/%x.
317 u8 interface_name_format_decimal;
319 /* per-device config */
320 dpdk_device_config_t default_devconf;
321 dpdk_device_config_t *dev_confs;
322 uword *device_config_index_by_pci_addr;
323 mhash_t device_config_index_by_vmbus_addr;
325 /* devices blacklist by pci vendor_id, device_id */
326 u32 *blacklist_by_pci_vendor_and_device;
327 /* devices blacklist by VMBUS address */
328 vlib_vmbus_addr_t *blacklist_by_vmbus_addr;
330 } dpdk_config_main_t;
332 extern dpdk_config_main_t dpdk_config_main;
334 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
338 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
339 struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
340 u32 buffers[DPDK_RX_BURST_SZ];
341 u16 next[DPDK_RX_BURST_SZ];
342 u16 etype[DPDK_RX_BURST_SZ];
343 u16 flags[DPDK_RX_BURST_SZ];
344 vlib_buffer_t buffer_template;
345 } dpdk_per_thread_data_t;
351 dpdk_device_t *devices;
352 dpdk_per_thread_data_t *per_thread_data;
354 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
355 u32 buffer_flags_template;
358 * flag indicating that a posted admin up/down
359 * (via post_sw_interface_set_flags) is in progress
361 u8 admin_up_down_in_progress;
363 /* control interval of dpdk link state and stat polling */
364 f64 link_state_poll_interval;
365 f64 stat_poll_interval;
368 vlib_main_t *vlib_main;
369 vnet_main_t *vnet_main;
370 dpdk_config_main_t *conf;
372 /* API message ID base */
376 vlib_log_class_t log_default;
377 vlib_log_class_t log_cryptodev;
378 vlib_log_class_t log_ipsec;
381 extern dpdk_main_t dpdk_main;
389 u8 data[256]; /* First 256 data bytes, used for hexdump */
390 /* Copy of VLIB buffer; packet data stored in pre_data. */
391 vlib_buffer_t buffer;
400 u8 data[256]; /* First 256 data bytes, used for hexdump */
401 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
404 void dpdk_device_setup (dpdk_device_t * xd);
405 void dpdk_device_start (dpdk_device_t * xd);
406 void dpdk_device_stop (dpdk_device_t * xd);
407 int dpdk_port_state_callback (dpdk_portid_t port_id,
408 enum rte_eth_event_type type,
409 void *param, void *ret_param);
411 #define foreach_dpdk_error \
412 _(NONE, "no error") \
413 _(RX_PACKET_ERROR, "Rx packet errors") \
414 _(RX_BAD_FCS, "Rx bad fcs") \
415 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
416 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
417 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
418 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
422 #define _(f,s) DPDK_ERROR_##f,
428 #define dpdk_log_err(...) \
429 vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
430 #define dpdk_log_warn(...) \
431 vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
432 #define dpdk_log_notice(...) \
433 vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
434 #define dpdk_log_info(...) \
435 vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
437 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
439 #define foreach_dpdk_rss_hf \
440 _(0, ETH_RSS_FRAG_IPV4, "ipv4-frag") \
441 _(1, ETH_RSS_NONFRAG_IPV4_TCP, "ipv4-tcp") \
442 _(2, ETH_RSS_NONFRAG_IPV4_UDP, "ipv4-udp") \
443 _(3, ETH_RSS_NONFRAG_IPV4_SCTP, "ipv4-sctp") \
444 _(4, ETH_RSS_NONFRAG_IPV4_OTHER, "ipv4-other") \
445 _(5, ETH_RSS_IPV4, "ipv4") \
446 _(6, ETH_RSS_IPV6_TCP_EX, "ipv6-tcp-ex") \
447 _(7, ETH_RSS_IPV6_UDP_EX, "ipv6-udp-ex") \
448 _(8, ETH_RSS_FRAG_IPV6, "ipv6-frag") \
449 _(9, ETH_RSS_NONFRAG_IPV6_TCP, "ipv6-tcp") \
450 _(10, ETH_RSS_NONFRAG_IPV6_UDP, "ipv6-udp") \
451 _(11, ETH_RSS_NONFRAG_IPV6_SCTP, "ipv6-sctp") \
452 _(12, ETH_RSS_NONFRAG_IPV6_OTHER, "ipv6-other") \
453 _(13, ETH_RSS_IPV6_EX, "ipv6-ex") \
454 _(14, ETH_RSS_IPV6, "ipv6") \
455 _(15, ETH_RSS_L2_PAYLOAD, "l2-payload") \
456 _(16, ETH_RSS_PORT, "port") \
457 _(17, ETH_RSS_VXLAN, "vxlan") \
458 _(18, ETH_RSS_GENEVE, "geneve") \
459 _(19, ETH_RSS_NVGRE, "nvgre") \
460 _(20, ETH_RSS_GTPU, "gtpu") \
461 _(60, ETH_RSS_L4_DST_ONLY, "l4-dst-only") \
462 _(61, ETH_RSS_L4_SRC_ONLY, "l4-src-only") \
463 _(62, ETH_RSS_L3_DST_ONLY, "l3-dst-only") \
464 _(63, ETH_RSS_L3_SRC_ONLY, "l3-src-only")
466 format_function_t format_dpdk_device_name;
467 format_function_t format_dpdk_device;
468 format_function_t format_dpdk_device_errors;
469 format_function_t format_dpdk_tx_trace;
470 format_function_t format_dpdk_rx_trace;
471 format_function_t format_dpdk_rte_mbuf;
472 format_function_t format_dpdk_rx_rte_mbuf;
473 format_function_t format_dpdk_flow;
474 format_function_t format_dpdk_rss_hf_name;
475 format_function_t format_dpdk_rx_offload_caps;
476 format_function_t format_dpdk_tx_offload_caps;
477 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
479 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
481 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
483 struct rte_vmbus_device *
484 dpdk_get_vmbus_device (const struct rte_eth_dev_info *info);
485 void dpdk_cli_reference (void);
488 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
489 void dpdk_buffer_poison_trajectory_all (void);
492 #endif /* __included_dpdk_h__ */
495 * fd.io coding-style-patch-verification: ON
498 * eval: (c-set-style "gnu")