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_virtio", VIRTIO) \
72 _ ("net_enic", ENIC) \
73 _ ("net_vmxnet3", VMXNET3) \
74 _ ("AF_PACKET PMD", AF_PACKET) \
75 _ ("net_fm10k", FM10K) \
76 _ ("net_cxgbe", CXGBE) \
77 _ ("net_mlx4", MLX4) \
78 _ ("net_mlx5", MLX5) \
79 _ ("net_dpaa2", DPAA2) \
80 _ ("net_virtio_user", VIRTIO_USER) \
81 _ ("net_vhost", VHOST_ETHER) \
83 _ ("net_failsafe", FAILSAFE) \
84 _ ("net_liovf", LIOVF_ETHER) \
85 _ ("net_qede", QEDE) \
86 _ ("net_netvsc", NETVSC) \
92 #define _(s,f) VNET_DPDK_PMD_##f,
95 VNET_DPDK_PMD_UNKNOWN, /* must be last */
100 VNET_DPDK_PORT_TYPE_ETH_1G,
101 VNET_DPDK_PORT_TYPE_ETH_2_5G,
102 VNET_DPDK_PORT_TYPE_ETH_5G,
103 VNET_DPDK_PORT_TYPE_ETH_10G,
104 VNET_DPDK_PORT_TYPE_ETH_20G,
105 VNET_DPDK_PORT_TYPE_ETH_25G,
106 VNET_DPDK_PORT_TYPE_ETH_40G,
107 VNET_DPDK_PORT_TYPE_ETH_50G,
108 VNET_DPDK_PORT_TYPE_ETH_56G,
109 VNET_DPDK_PORT_TYPE_ETH_100G,
110 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
111 VNET_DPDK_PORT_TYPE_AF_PACKET,
112 VNET_DPDK_PORT_TYPE_ETH_VF,
113 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
114 VNET_DPDK_PORT_TYPE_VHOST_ETHER,
115 VNET_DPDK_PORT_TYPE_FAILSAFE,
116 VNET_DPDK_PORT_TYPE_NETVSC,
117 VNET_DPDK_PORT_TYPE_UNKNOWN,
120 typedef uint16_t dpdk_portid_t;
122 #define foreach_dpdk_device_flags \
123 _( 0, ADMIN_UP, "admin-up") \
124 _( 1, PROMISC, "promisc") \
126 _( 3, PMD_INIT_FAIL, "pmd-init-fail") \
127 _( 4, MAYBE_MULTISEG, "maybe-multiseg") \
128 _( 5, HAVE_SUBIF, "subif") \
129 _( 9, TX_OFFLOAD, "tx-offload") \
130 _(10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
131 _(11, RX_FLOW_OFFLOAD, "rx-flow-offload") \
132 _(12, RX_IP4_CKSUM, "rx-ip4-cksum")
136 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
137 foreach_dpdk_device_flags
145 struct rte_flow *handle;
153 } dpdk_flow_lookup_entry_t;
157 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
158 volatile u32 **lockp;
160 /* Instance ID to access internal device array. */
161 dpdk_portid_t device_index;
163 /* DPDK device port number */
164 dpdk_portid_t port_id;
169 /* next node index if we decide to steal the rx graph arc */
170 u32 per_interface_next_index;
178 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
181 u8 *interface_name_suffix;
183 /* number of sub-interfaces */
190 u16 *cpu_socket_id_by_queue;
191 u8 *buffer_pool_for_queue;
192 struct rte_eth_conf port_conf;
193 struct rte_eth_txconf tx_conf;
196 u32 supported_flow_actions;
197 dpdk_flow_entry_t *flow_entries; /* pool */
198 dpdk_flow_lookup_entry_t *flow_lookup_entries; /* pool */
199 u32 *parked_lookup_indexes; /* vector */
200 u32 parked_loop_count;
201 struct rte_flow_error last_flow_error;
203 /* af_packet instance number */
204 u16 af_packet_instance_num;
206 struct rte_eth_link link;
207 f64 time_last_link_update;
209 struct rte_eth_stats stats;
210 struct rte_eth_stats last_stats;
211 struct rte_eth_xstat *xstats;
212 f64 time_last_stats_update;
213 dpdk_port_type_t port_type;
216 u8 *default_mac_address;
219 clib_error_t *errors;
222 #define DPDK_STATS_POLL_INTERVAL (10.0)
223 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
225 #define DPDK_LINK_POLL_INTERVAL (3.0)
226 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
232 } dpdk_device_and_queue_t;
234 #ifndef DPDK_HQOS_DBG_BYPASS
235 #define DPDK_HQOS_DBG_BYPASS 0
238 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
239 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
243 #define foreach_dpdk_device_config_item \
252 vlib_pci_addr_t pci_addr;
255 u8 vlan_strip_offload;
256 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
257 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
258 #define DPDK_DEVICE_VLAN_STRIP_ON 2
260 #define _(x) uword x;
261 foreach_dpdk_device_config_item
263 clib_bitmap_t * workers;
267 #define DPDK_DEVICE_TSO_DEFAULT 0
268 #define DPDK_DEVICE_TSO_OFF 1
269 #define DPDK_DEVICE_TSO_ON 2
270 } dpdk_device_config_t;
277 u8 *eal_init_args_str;
280 u8 enable_tcp_udp_checksum;
281 u8 no_tx_checksum_offload;
283 /* Required config parameters */
284 u8 coremask_set_manually;
285 u8 nchannels_set_manually;
288 u32 num_crypto_mbufs;
291 * format interface names ala xxxEthernet%d/%d/%d instead of
292 * xxxEthernet%x/%x/%x.
294 u8 interface_name_format_decimal;
296 /* per-device config */
297 dpdk_device_config_t default_devconf;
298 dpdk_device_config_t *dev_confs;
299 uword *device_config_index_by_pci_addr;
301 /* devices blacklist by pci vendor_id, device_id */
302 u32 *blacklist_by_pci_vendor_and_device;
304 } dpdk_config_main_t;
306 extern dpdk_config_main_t dpdk_config_main;
308 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
312 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
313 struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
314 u32 buffers[DPDK_RX_BURST_SZ];
315 u16 next[DPDK_RX_BURST_SZ];
316 u16 etype[DPDK_RX_BURST_SZ];
317 u16 flags[DPDK_RX_BURST_SZ];
318 vlib_buffer_t buffer_template;
319 } dpdk_per_thread_data_t;
325 dpdk_device_t *devices;
326 dpdk_per_thread_data_t *per_thread_data;
328 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
329 u32 buffer_flags_template;
332 * flag indicating that a posted admin up/down
333 * (via post_sw_interface_set_flags) is in progress
335 u8 admin_up_down_in_progress;
337 /* control interval of dpdk link state and stat polling */
338 f64 link_state_poll_interval;
339 f64 stat_poll_interval;
342 vlib_main_t *vlib_main;
343 vnet_main_t *vnet_main;
344 dpdk_config_main_t *conf;
346 /* API message ID base */
350 vlib_log_class_t log_default;
353 extern dpdk_main_t dpdk_main;
361 /* Copy of VLIB buffer; packet data stored in pre_data. */
362 vlib_buffer_t buffer;
363 u8 data[256]; /* First 256 data bytes, used for hexdump */
372 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
373 u8 data[256]; /* First 256 data bytes, used for hexdump */
376 void dpdk_device_setup (dpdk_device_t * xd);
377 void dpdk_device_start (dpdk_device_t * xd);
378 void dpdk_device_stop (dpdk_device_t * xd);
380 int dpdk_port_state_callback (dpdk_portid_t port_id,
381 enum rte_eth_event_type type,
382 void *param, void *ret_param);
384 #define foreach_dpdk_error \
385 _(NONE, "no error") \
386 _(RX_PACKET_ERROR, "Rx packet errors") \
387 _(RX_BAD_FCS, "Rx bad fcs") \
388 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
389 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
390 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
391 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
395 #define _(f,s) DPDK_ERROR_##f,
401 #define dpdk_log_err(...) \
402 vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
403 #define dpdk_log_warn(...) \
404 vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
405 #define dpdk_log_notice(...) \
406 vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
407 #define dpdk_log_info(...) \
408 vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
410 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
412 format_function_t format_dpdk_device_name;
413 format_function_t format_dpdk_device;
414 format_function_t format_dpdk_device_errors;
415 format_function_t format_dpdk_tx_trace;
416 format_function_t format_dpdk_rx_trace;
417 format_function_t format_dpdk_rte_mbuf;
418 format_function_t format_dpdk_rx_rte_mbuf;
419 format_function_t format_dpdk_flow;
420 format_function_t format_dpdk_rss_hf_name;
421 format_function_t format_dpdk_rx_offload_caps;
422 format_function_t format_dpdk_tx_offload_caps;
423 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
425 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
427 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
429 void dpdk_cli_reference (void);
432 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
433 void dpdk_buffer_poison_trajectory_all (void);
436 #endif /* __included_dpdk_h__ */
439 * fd.io coding-style-patch-verification: ON
442 * eval: (c-set-style "gnu")