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 #include <rte_config.h>
23 #include <rte_common.h>
25 #include <rte_memory.h>
27 #include <rte_per_lcore.h>
28 #include <rte_cycles.h>
29 #include <rte_lcore.h>
30 #include <rte_per_lcore.h>
31 #include <rte_interrupts.h>
33 #include <rte_ether.h>
34 #include <rte_ethdev.h>
36 #include <rte_mempool.h>
38 #include <rte_version.h>
39 #include <rte_eth_bond.h>
40 #include <rte_sched.h>
42 #include <vnet/unix/pcap.h>
43 #include <vnet/devices/devices.h>
46 #define always_inline static inline
48 #define always_inline static inline __attribute__ ((__always_inline__))
51 #include <vlib/pci/pci.h>
53 #define NB_MBUF (16<<10)
55 extern vnet_device_class_t dpdk_device_class;
56 extern vlib_node_registration_t dpdk_input_node;
58 #if RTE_VERSION >= RTE_VERSION_NUM(17, 2, 0, 0)
59 #define foreach_dpdk_pmd \
60 _ ("net_thunderx", THUNDERX) \
61 _ ("net_e1000_em", E1000EM) \
62 _ ("net_e1000_igb", IGB) \
63 _ ("net_e1000_igb_vf", IGBVF) \
64 _ ("net_ixgbe", IXGBE) \
65 _ ("net_ixgbe_vf", IXGBEVF) \
66 _ ("net_i40e", I40E) \
67 _ ("net_i40e_vf", I40EVF) \
68 _ ("net_virtio", VIRTIO) \
69 _ ("net_enic", ENIC) \
70 _ ("net_vmxnet3", VMXNET3) \
71 _ ("AF_PACKET PMD", AF_PACKET) \
72 _ ("net_bonding", BOND) \
73 _ ("net_fm10k", FM10K) \
74 _ ("net_cxgbe", CXGBE) \
75 _ ("net_mlx5", MLX5) \
76 _ ("net_dpaa2", DPAA2)
78 #define foreach_dpdk_pmd \
79 _ ("net_thunderx", THUNDERX) \
80 _ ("net_e1000_em", E1000EM) \
81 _ ("net_e1000_igb", IGB) \
82 _ ("net_e1000_igb_vf", IGBVF) \
83 _ ("net_ixgbe", IXGBE) \
84 _ ("net_ixgbe_vf", IXGBEVF) \
85 _ ("net_i40e", I40E) \
86 _ ("net_i40e_vf", I40EVF) \
87 _ ("net_virtio", VIRTIO) \
88 _ ("net_enic", ENIC) \
89 _ ("net_vmxnet3", VMXNET3) \
90 _ ("AF_PACKET PMD", AF_PACKET) \
91 _ ("rte_bond_pmd", BOND) \
92 _ ("net_fm10k", FM10K) \
93 _ ("net_cxgbe", CXGBE) \
94 _ ("net_mlx5", MLX5) \
95 _ ("net_dpaa2", DPAA2)
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_10G,
111 VNET_DPDK_PORT_TYPE_ETH_25G,
112 VNET_DPDK_PORT_TYPE_ETH_40G,
113 VNET_DPDK_PORT_TYPE_ETH_100G,
114 VNET_DPDK_PORT_TYPE_ETH_BOND,
115 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
116 VNET_DPDK_PORT_TYPE_AF_PACKET,
117 VNET_DPDK_PORT_TYPE_UNKNOWN,
121 * The header for the tx_vector in dpdk_device_t.
122 * Head and tail are indexes into the tx_vector and are of type
123 * u64 so they never overflow.
133 struct rte_ring *swq;
135 u64 hqos_field0_slabmask;
136 u32 hqos_field0_slabpos;
137 u32 hqos_field0_slabshr;
138 u64 hqos_field1_slabmask;
139 u32 hqos_field1_slabpos;
140 u32 hqos_field1_slabshr;
141 u64 hqos_field2_slabmask;
142 u32 hqos_field2_slabpos;
143 u32 hqos_field2_slabshr;
144 u32 hqos_tc_table[64];
145 } dpdk_device_hqos_per_worker_thread_t;
149 struct rte_ring **swq;
150 struct rte_mbuf **pkts_enq;
151 struct rte_mbuf **pkts_deq;
152 struct rte_sched_port *hqos;
158 } dpdk_device_hqos_per_hqos_thread_t;
162 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
163 volatile u32 **lockp;
169 u32 vlib_sw_if_index;
171 /* next node index if we decide to steal the rx graph arc */
172 u32 per_interface_next_index;
174 /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
175 struct rte_mbuf ***tx_vectors; /* one per worker thread */
176 struct rte_mbuf ***rx_vectors;
178 /* vector of traced contexts, per device */
179 u32 **d_trace_buffers;
185 #define DPDK_DEVICE_FLAG_ADMIN_UP (1 << 0)
186 #define DPDK_DEVICE_FLAG_PROMISC (1 << 1)
187 #define DPDK_DEVICE_FLAG_PMD (1 << 2)
188 #define DPDK_DEVICE_FLAG_PMD_SUPPORTS_PTYPE (1 << 3)
189 #define DPDK_DEVICE_FLAG_MAYBE_MULTISEG (1 << 4)
190 #define DPDK_DEVICE_FLAG_HAVE_SUBIF (1 << 5)
191 #define DPDK_DEVICE_FLAG_HQOS (1 << 6)
194 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
196 u8 *interface_name_suffix;
198 /* number of sub-interfaces */
205 u16 *cpu_socket_id_by_queue;
206 struct rte_eth_conf port_conf;
207 struct rte_eth_txconf tx_conf;
210 dpdk_device_hqos_per_worker_thread_t *hqos_wt;
211 dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
213 /* af_packet or BondEthernet instance number */
216 struct rte_eth_link link;
217 f64 time_last_link_update;
219 struct rte_eth_stats stats;
220 struct rte_eth_stats last_stats;
221 struct rte_eth_stats last_cleared_stats;
222 struct rte_eth_xstat *xstats;
223 struct rte_eth_xstat *last_cleared_xstats;
224 f64 time_last_stats_update;
225 dpdk_port_type_t port_type;
228 u8 *default_mac_address;
231 #define DPDK_STATS_POLL_INTERVAL (10.0)
232 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
234 #define DPDK_LINK_POLL_INTERVAL (3.0)
235 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
241 } dpdk_device_and_queue_t;
243 #ifndef DPDK_HQOS_DBG_BYPASS
244 #define DPDK_HQOS_DBG_BYPASS 0
247 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
248 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
251 typedef struct dpdk_device_config_hqos_t
254 u32 hqos_thread_valid;
260 u32 pktfield0_slabpos;
261 u32 pktfield1_slabpos;
262 u32 pktfield2_slabpos;
263 u64 pktfield0_slabmask;
264 u64 pktfield1_slabmask;
265 u64 pktfield2_slabmask;
268 struct rte_sched_port_params port;
269 struct rte_sched_subport_params *subport;
270 struct rte_sched_pipe_params *pipe;
272 } dpdk_device_config_hqos_t;
274 int dpdk_hqos_validate_mask (u64 mask, u32 n);
275 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
276 hqos, u32 pipe_profile_id);
277 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
278 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
279 dpdk_device_config_hqos_t * hqos);
280 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
281 struct rte_mbuf **pkts, u32 n_pkts);
283 #define foreach_dpdk_device_config_item \
292 vlib_pci_addr_t pci_addr;
294 u8 vlan_strip_offload;
295 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
296 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
297 #define DPDK_DEVICE_VLAN_STRIP_ON 2
299 #define _(x) uword x;
300 foreach_dpdk_device_config_item
302 clib_bitmap_t * workers;
304 dpdk_device_config_hqos_t hqos;
305 } dpdk_device_config_t;
312 u8 *eal_init_args_str;
315 u8 enable_tcp_udp_checksum;
317 /* Required config parameters */
318 u8 coremask_set_manually;
319 u8 nchannels_set_manually;
325 * format interface names ala xxxEthernet%d/%d/%d instead of
326 * xxxEthernet%x/%x/%x.
328 u8 interface_name_format_decimal;
330 /* per-device config */
331 dpdk_device_config_t default_devconf;
332 dpdk_device_config_t *dev_confs;
333 uword *device_config_index_by_pci_addr;
335 } dpdk_config_main_t;
337 dpdk_config_main_t dpdk_config_main;
343 dpdk_device_t *devices;
344 dpdk_device_and_queue_t **devices_by_hqos_cpu;
346 /* per-thread recycle lists */
349 /* per-thread buffer templates */
350 vlib_buffer_t *buffer_templates;
352 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
353 u32 buffer_flags_template;
355 /* vlib buffer free list, must be same size as an rte_mbuf */
356 u32 vlib_buffer_free_list_index;
358 /* Ethernet input node index */
359 u32 ethernet_input_node_index;
361 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
363 pcap_main_t pcap_main;
365 u32 pcap_sw_if_index;
366 u32 pcap_pkts_to_capture;
369 * flag indicating that a posted admin up/down
370 * (via post_sw_interface_set_flags) is in progress
372 u8 admin_up_down_in_progress;
376 /* which cpus are running I/O TX */
377 int hqos_cpu_first_index;
380 /* control interval of dpdk link state and stat polling */
381 f64 link_state_poll_interval;
382 f64 stat_poll_interval;
384 /* Sleep for this many usec after each device poll */
388 vlib_main_t *vlib_main;
389 vnet_main_t *vnet_main;
390 dpdk_config_main_t *conf;
393 struct rte_mempool **pktmbuf_pools;
395 /* API message ID base */
399 extern dpdk_main_t dpdk_main;
407 /* Copy of VLIB buffer; packet data stored in pre_data. */
408 vlib_buffer_t buffer;
409 } dpdk_tx_dma_trace_t;
417 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
418 u8 data[256]; /* First 256 data bytes, used for hexdump */
419 } dpdk_rx_dma_trace_t;
421 clib_error_t *dpdk_port_setup (dpdk_main_t * dm, dpdk_device_t * xd);
423 #define foreach_dpdk_error \
424 _(NONE, "no error") \
425 _(RX_PACKET_ERROR, "Rx packet errors") \
426 _(RX_BAD_FCS, "Rx bad fcs") \
427 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
428 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
429 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
430 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
434 #define _(f,s) DPDK_ERROR_##f,
440 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
442 format_function_t format_dpdk_device_name;
443 format_function_t format_dpdk_device;
444 format_function_t format_dpdk_tx_dma_trace;
445 format_function_t format_dpdk_rx_dma_trace;
446 format_function_t format_dpdk_rte_mbuf;
447 format_function_t format_dpdk_rx_rte_mbuf;
448 unformat_function_t unformat_socket_mem;
449 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
450 clib_error_t *unformat_hqos (unformat_input_t * input,
451 dpdk_device_config_hqos_t * hqos);
454 admin_up_down_process (vlib_main_t * vm,
455 vlib_node_runtime_t * rt, vlib_frame_t * f);
457 #endif /* __included_dpdk_h__ */
460 * fd.io coding-style-patch-verification: ON
463 * eval: (c-set-style "gnu")