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_ether.h>
36 #include <rte_ethdev.h>
38 #include <rte_mempool.h>
40 #include <rte_version.h>
41 #include <rte_sched.h>
43 #include <rte_bus_pci.h>
46 #include <vnet/devices/devices.h>
49 #define always_inline static inline
51 #define always_inline static inline __attribute__ ((__always_inline__))
54 #include <vlib/pci/pci.h>
55 #include <vnet/flow/flow.h>
57 extern vnet_device_class_t dpdk_device_class;
58 extern vlib_node_registration_t dpdk_input_node;
59 extern vlib_node_registration_t admin_up_down_process_node;
61 #define foreach_dpdk_pmd \
62 _ ("net_thunderx", THUNDERX) \
63 _ ("net_e1000_em", E1000EM) \
64 _ ("net_e1000_igb", IGB) \
65 _ ("net_e1000_igb_vf", IGBVF) \
66 _ ("net_ixgbe", IXGBE) \
67 _ ("net_ixgbe_vf", IXGBEVF) \
68 _ ("net_i40e", I40E) \
69 _ ("net_i40e_vf", I40EVF) \
71 _ ("net_iavf", IAVF) \
72 _ ("net_virtio", VIRTIO) \
73 _ ("net_enic", ENIC) \
74 _ ("net_vmxnet3", VMXNET3) \
75 _ ("AF_PACKET PMD", AF_PACKET) \
76 _ ("net_fm10k", FM10K) \
77 _ ("net_cxgbe", CXGBE) \
78 _ ("net_mlx4", MLX4) \
79 _ ("net_mlx5", MLX5) \
80 _ ("net_dpaa2", DPAA2) \
81 _ ("net_virtio_user", VIRTIO_USER) \
82 _ ("net_vhost", VHOST_ETHER) \
84 _ ("net_failsafe", FAILSAFE) \
85 _ ("net_liovf", LIOVF_ETHER) \
86 _ ("net_qede", QEDE) \
87 _ ("net_netvsc", NETVSC) \
93 #define _(s,f) VNET_DPDK_PMD_##f,
96 VNET_DPDK_PMD_UNKNOWN, /* must be last */
101 VNET_DPDK_PORT_TYPE_ETH_1G,
102 VNET_DPDK_PORT_TYPE_ETH_2_5G,
103 VNET_DPDK_PORT_TYPE_ETH_5G,
104 VNET_DPDK_PORT_TYPE_ETH_10G,
105 VNET_DPDK_PORT_TYPE_ETH_20G,
106 VNET_DPDK_PORT_TYPE_ETH_25G,
107 VNET_DPDK_PORT_TYPE_ETH_40G,
108 VNET_DPDK_PORT_TYPE_ETH_50G,
109 VNET_DPDK_PORT_TYPE_ETH_56G,
110 VNET_DPDK_PORT_TYPE_ETH_100G,
111 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
112 VNET_DPDK_PORT_TYPE_AF_PACKET,
113 VNET_DPDK_PORT_TYPE_ETH_VF,
114 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
115 VNET_DPDK_PORT_TYPE_VHOST_ETHER,
116 VNET_DPDK_PORT_TYPE_FAILSAFE,
117 VNET_DPDK_PORT_TYPE_NETVSC,
118 VNET_DPDK_PORT_TYPE_UNKNOWN,
121 typedef uint16_t dpdk_portid_t;
123 #define foreach_dpdk_device_flags \
124 _( 0, ADMIN_UP, "admin-up") \
125 _( 1, PROMISC, "promisc") \
127 _( 3, PMD_INIT_FAIL, "pmd-init-fail") \
128 _( 4, MAYBE_MULTISEG, "maybe-multiseg") \
129 _( 5, HAVE_SUBIF, "subif") \
130 _( 9, TX_OFFLOAD, "tx-offload") \
131 _(10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
132 _(11, RX_FLOW_OFFLOAD, "rx-flow-offload") \
133 _(12, RX_IP4_CKSUM, "rx-ip4-cksum")
137 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
138 foreach_dpdk_device_flags
146 struct rte_flow *handle;
154 } dpdk_flow_lookup_entry_t;
158 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
159 u8 buffer_pool_index;
164 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
165 clib_spinlock_t lock;
170 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
172 dpdk_rx_queue_t *rx_queues;
173 dpdk_tx_queue_t *tx_queues;
175 /* 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 \
249 vlib_pci_addr_t pci_addr;
252 u8 vlan_strip_offload;
253 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
254 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
255 #define DPDK_DEVICE_VLAN_STRIP_ON 2
257 #define _(x) uword x;
258 foreach_dpdk_device_config_item
260 clib_bitmap_t * workers;
264 #define DPDK_DEVICE_TSO_DEFAULT 0
265 #define DPDK_DEVICE_TSO_OFF 1
266 #define DPDK_DEVICE_TSO_ON 2
267 } dpdk_device_config_t;
274 u8 *eal_init_args_str;
277 u8 enable_tcp_udp_checksum;
278 u8 no_tx_checksum_offload;
280 /* Required config parameters */
281 u8 coremask_set_manually;
282 u8 nchannels_set_manually;
285 u32 num_crypto_mbufs;
288 * format interface names ala xxxEthernet%d/%d/%d instead of
289 * xxxEthernet%x/%x/%x.
291 u8 interface_name_format_decimal;
293 /* per-device config */
294 dpdk_device_config_t default_devconf;
295 dpdk_device_config_t *dev_confs;
296 uword *device_config_index_by_pci_addr;
298 /* devices blacklist by pci vendor_id, device_id */
299 u32 *blacklist_by_pci_vendor_and_device;
301 } dpdk_config_main_t;
303 extern dpdk_config_main_t dpdk_config_main;
305 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
309 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
310 struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
311 u32 buffers[DPDK_RX_BURST_SZ];
312 u16 next[DPDK_RX_BURST_SZ];
313 u16 etype[DPDK_RX_BURST_SZ];
314 u16 flags[DPDK_RX_BURST_SZ];
315 vlib_buffer_t buffer_template;
316 } dpdk_per_thread_data_t;
322 dpdk_device_t *devices;
323 dpdk_per_thread_data_t *per_thread_data;
325 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
326 u32 buffer_flags_template;
329 * flag indicating that a posted admin up/down
330 * (via post_sw_interface_set_flags) is in progress
332 u8 admin_up_down_in_progress;
334 /* control interval of dpdk link state and stat polling */
335 f64 link_state_poll_interval;
336 f64 stat_poll_interval;
339 vlib_main_t *vlib_main;
340 vnet_main_t *vnet_main;
341 dpdk_config_main_t *conf;
343 /* API message ID base */
347 vlib_log_class_t log_default;
350 extern dpdk_main_t dpdk_main;
358 /* Copy of VLIB buffer; packet data stored in pre_data. */
359 vlib_buffer_t buffer;
360 u8 data[256]; /* First 256 data bytes, used for hexdump */
369 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
370 u8 data[256]; /* First 256 data bytes, used for hexdump */
373 void dpdk_device_setup (dpdk_device_t * xd);
374 void dpdk_device_start (dpdk_device_t * xd);
375 void dpdk_device_stop (dpdk_device_t * xd);
377 int dpdk_port_state_callback (dpdk_portid_t port_id,
378 enum rte_eth_event_type type,
379 void *param, void *ret_param);
381 #define foreach_dpdk_error \
382 _(NONE, "no error") \
383 _(RX_PACKET_ERROR, "Rx packet errors") \
384 _(RX_BAD_FCS, "Rx bad fcs") \
385 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
386 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
387 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
388 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
392 #define _(f,s) DPDK_ERROR_##f,
398 #define dpdk_log_err(...) \
399 vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
400 #define dpdk_log_warn(...) \
401 vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
402 #define dpdk_log_notice(...) \
403 vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
404 #define dpdk_log_info(...) \
405 vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
407 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
409 #define foreach_dpdk_rss_hf \
410 _(0, ETH_RSS_FRAG_IPV4, "ipv4-frag") \
411 _(1, ETH_RSS_NONFRAG_IPV4_TCP, "ipv4-tcp") \
412 _(2, ETH_RSS_NONFRAG_IPV4_UDP, "ipv4-udp") \
413 _(3, ETH_RSS_NONFRAG_IPV4_SCTP, "ipv4-sctp") \
414 _(4, ETH_RSS_NONFRAG_IPV4_OTHER, "ipv4-other") \
415 _(5, ETH_RSS_IPV4, "ipv4") \
416 _(6, ETH_RSS_IPV6_TCP_EX, "ipv6-tcp-ex") \
417 _(7, ETH_RSS_IPV6_UDP_EX, "ipv6-udp-ex") \
418 _(8, ETH_RSS_FRAG_IPV6, "ipv6-frag") \
419 _(9, ETH_RSS_NONFRAG_IPV6_TCP, "ipv6-tcp") \
420 _(10, ETH_RSS_NONFRAG_IPV6_UDP, "ipv6-udp") \
421 _(11, ETH_RSS_NONFRAG_IPV6_SCTP, "ipv6-sctp") \
422 _(12, ETH_RSS_NONFRAG_IPV6_OTHER, "ipv6-other") \
423 _(13, ETH_RSS_IPV6_EX, "ipv6-ex") \
424 _(14, ETH_RSS_IPV6, "ipv6") \
425 _(15, ETH_RSS_L2_PAYLOAD, "l2-payload") \
426 _(16, ETH_RSS_PORT, "port") \
427 _(17, ETH_RSS_VXLAN, "vxlan") \
428 _(18, ETH_RSS_GENEVE, "geneve") \
429 _(19, ETH_RSS_NVGRE, "nvgre") \
430 _(20, ETH_RSS_GTPU, "gtpu") \
431 _(60, ETH_RSS_L4_DST_ONLY, "l4-dst-only") \
432 _(61, ETH_RSS_L4_SRC_ONLY, "l4-src-only") \
433 _(62, ETH_RSS_L3_DST_ONLY, "l3-dst-only") \
434 _(63, ETH_RSS_L3_SRC_ONLY, "l3-src-only")
436 format_function_t format_dpdk_device_name;
437 format_function_t format_dpdk_device;
438 format_function_t format_dpdk_device_errors;
439 format_function_t format_dpdk_tx_trace;
440 format_function_t format_dpdk_rx_trace;
441 format_function_t format_dpdk_rte_mbuf;
442 format_function_t format_dpdk_rx_rte_mbuf;
443 format_function_t format_dpdk_flow;
444 format_function_t format_dpdk_rss_hf_name;
445 format_function_t format_dpdk_rx_offload_caps;
446 format_function_t format_dpdk_tx_offload_caps;
447 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
449 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
451 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
453 void dpdk_cli_reference (void);
456 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
457 void dpdk_buffer_poison_trajectory_all (void);
460 #endif /* __included_dpdk_h__ */
463 * fd.io coding-style-patch-verification: ON
466 * eval: (c-set-style "gnu")