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 #define foreach_dpdk_pmd \
59 _ ("net_thunderx", THUNDERX) \
60 _ ("net_e1000_em", E1000EM) \
61 _ ("net_e1000_igb", IGB) \
62 _ ("net_e1000_igb_vf", IGBVF) \
63 _ ("net_ixgbe", IXGBE) \
64 _ ("net_ixgbe_vf", IXGBEVF) \
65 _ ("net_i40e", I40E) \
66 _ ("net_i40e_vf", I40EVF) \
67 _ ("net_virtio", VIRTIO) \
68 _ ("net_enic", ENIC) \
69 _ ("net_vmxnet3", VMXNET3) \
70 _ ("AF_PACKET PMD", AF_PACKET) \
71 _ ("net_bonding", BOND) \
72 _ ("net_fm10k", FM10K) \
73 _ ("net_cxgbe", CXGBE) \
74 _ ("net_mlx4", MLX4) \
75 _ ("net_mlx5", MLX5) \
76 _ ("net_dpaa2", DPAA2) \
77 _ ("net_virtio_user", VIRTIO_USER)
83 #define _(s,f) VNET_DPDK_PMD_##f,
86 VNET_DPDK_PMD_UNKNOWN, /* must be last */
91 VNET_DPDK_PORT_TYPE_ETH_1G,
92 VNET_DPDK_PORT_TYPE_ETH_10G,
93 VNET_DPDK_PORT_TYPE_ETH_25G,
94 VNET_DPDK_PORT_TYPE_ETH_40G,
95 VNET_DPDK_PORT_TYPE_ETH_100G,
96 VNET_DPDK_PORT_TYPE_ETH_BOND,
97 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
98 VNET_DPDK_PORT_TYPE_AF_PACKET,
99 VNET_DPDK_PORT_TYPE_ETH_VF,
100 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
101 VNET_DPDK_PORT_TYPE_UNKNOWN,
105 * The header for the tx_vector in dpdk_device_t.
106 * Head and tail are indexes into the tx_vector and are of type
107 * u64 so they never overflow.
117 struct rte_ring *swq;
119 u64 hqos_field0_slabmask;
120 u32 hqos_field0_slabpos;
121 u32 hqos_field0_slabshr;
122 u64 hqos_field1_slabmask;
123 u32 hqos_field1_slabpos;
124 u32 hqos_field1_slabshr;
125 u64 hqos_field2_slabmask;
126 u32 hqos_field2_slabpos;
127 u32 hqos_field2_slabshr;
128 u32 hqos_tc_table[64];
129 } dpdk_device_hqos_per_worker_thread_t;
133 struct rte_ring **swq;
134 struct rte_mbuf **pkts_enq;
135 struct rte_mbuf **pkts_deq;
136 struct rte_sched_port *hqos;
142 } dpdk_device_hqos_per_hqos_thread_t;
146 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
147 volatile u32 **lockp;
153 u32 vlib_sw_if_index;
155 /* next node index if we decide to steal the rx graph arc */
156 u32 per_interface_next_index;
158 /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
159 struct rte_mbuf ***tx_vectors; /* one per worker thread */
160 struct rte_mbuf ***rx_vectors;
162 /* vector of traced contexts, per device */
163 u32 **d_trace_buffers;
169 #define DPDK_DEVICE_FLAG_ADMIN_UP (1 << 0)
170 #define DPDK_DEVICE_FLAG_PROMISC (1 << 1)
171 #define DPDK_DEVICE_FLAG_PMD (1 << 2)
172 #define DPDK_DEVICE_FLAG_PMD_INIT_FAIL (1 << 3)
173 #define DPDK_DEVICE_FLAG_MAYBE_MULTISEG (1 << 4)
174 #define DPDK_DEVICE_FLAG_HAVE_SUBIF (1 << 5)
175 #define DPDK_DEVICE_FLAG_HQOS (1 << 6)
178 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
180 u8 *interface_name_suffix;
182 /* number of sub-interfaces */
189 u16 *cpu_socket_id_by_queue;
190 struct rte_eth_conf port_conf;
191 struct rte_eth_txconf tx_conf;
194 dpdk_device_hqos_per_worker_thread_t *hqos_wt;
195 dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
197 /* af_packet or BondEthernet instance number */
200 struct rte_eth_link link;
201 f64 time_last_link_update;
203 struct rte_eth_stats stats;
204 struct rte_eth_stats last_stats;
205 struct rte_eth_stats last_cleared_stats;
206 struct rte_eth_xstat *xstats;
207 struct rte_eth_xstat *last_cleared_xstats;
208 f64 time_last_stats_update;
209 dpdk_port_type_t port_type;
212 u8 *default_mac_address;
215 clib_error_t *errors;
218 #define DPDK_STATS_POLL_INTERVAL (10.0)
219 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
221 #define DPDK_LINK_POLL_INTERVAL (3.0)
222 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
228 } dpdk_device_and_queue_t;
230 #ifndef DPDK_HQOS_DBG_BYPASS
231 #define DPDK_HQOS_DBG_BYPASS 0
234 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
235 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
238 typedef struct dpdk_device_config_hqos_t
241 u32 hqos_thread_valid;
247 u32 pktfield0_slabpos;
248 u32 pktfield1_slabpos;
249 u32 pktfield2_slabpos;
250 u64 pktfield0_slabmask;
251 u64 pktfield1_slabmask;
252 u64 pktfield2_slabmask;
255 struct rte_sched_port_params port;
256 struct rte_sched_subport_params *subport;
257 struct rte_sched_pipe_params *pipe;
259 } dpdk_device_config_hqos_t;
261 int dpdk_hqos_validate_mask (u64 mask, u32 n);
262 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
263 hqos, u32 pipe_profile_id);
264 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
265 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
266 dpdk_device_config_hqos_t * hqos);
267 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
268 struct rte_mbuf **pkts, u32 n_pkts);
270 #define foreach_dpdk_device_config_item \
279 vlib_pci_addr_t pci_addr;
281 u8 vlan_strip_offload;
282 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
283 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
284 #define DPDK_DEVICE_VLAN_STRIP_ON 2
286 #define _(x) uword x;
287 foreach_dpdk_device_config_item
289 clib_bitmap_t * workers;
291 dpdk_device_config_hqos_t hqos;
292 } dpdk_device_config_t;
299 u8 *eal_init_args_str;
302 u8 enable_tcp_udp_checksum;
304 /* Required config parameters */
305 u8 coremask_set_manually;
306 u8 nchannels_set_manually;
312 * format interface names ala xxxEthernet%d/%d/%d instead of
313 * xxxEthernet%x/%x/%x.
315 u8 interface_name_format_decimal;
317 /* per-device config */
318 dpdk_device_config_t default_devconf;
319 dpdk_device_config_t *dev_confs;
320 uword *device_config_index_by_pci_addr;
322 } dpdk_config_main_t;
324 dpdk_config_main_t dpdk_config_main;
330 dpdk_device_t *devices;
331 dpdk_device_and_queue_t **devices_by_hqos_cpu;
333 /* per-thread recycle lists */
336 /* per-thread buffer templates */
337 vlib_buffer_t *buffer_templates;
339 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
340 u32 buffer_flags_template;
342 /* vlib buffer free list, must be same size as an rte_mbuf */
343 u32 vlib_buffer_free_list_index;
345 /* Ethernet input node index */
346 u32 ethernet_input_node_index;
348 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
350 pcap_main_t pcap_main;
352 u32 pcap_sw_if_index;
353 u32 pcap_pkts_to_capture;
356 * flag indicating that a posted admin up/down
357 * (via post_sw_interface_set_flags) is in progress
359 u8 admin_up_down_in_progress;
363 /* which cpus are running I/O TX */
364 int hqos_cpu_first_index;
367 /* control interval of dpdk link state and stat polling */
368 f64 link_state_poll_interval;
369 f64 stat_poll_interval;
371 /* Sleep for this many usec after each device poll */
375 vlib_main_t *vlib_main;
376 vnet_main_t *vnet_main;
377 dpdk_config_main_t *conf;
380 struct rte_mempool **pktmbuf_pools;
382 /* API message ID base */
386 extern dpdk_main_t dpdk_main;
394 /* Copy of VLIB buffer; packet data stored in pre_data. */
395 vlib_buffer_t buffer;
396 } dpdk_tx_dma_trace_t;
404 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
405 u8 data[256]; /* First 256 data bytes, used for hexdump */
406 } dpdk_rx_dma_trace_t;
408 void dpdk_device_setup (dpdk_device_t * xd);
409 void dpdk_device_start (dpdk_device_t * xd);
410 void dpdk_device_stop (dpdk_device_t * xd);
412 #define foreach_dpdk_error \
413 _(NONE, "no error") \
414 _(RX_PACKET_ERROR, "Rx packet errors") \
415 _(RX_BAD_FCS, "Rx bad fcs") \
416 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
417 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
418 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
419 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
423 #define _(f,s) DPDK_ERROR_##f,
429 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
431 format_function_t format_dpdk_device_name;
432 format_function_t format_dpdk_device;
433 format_function_t format_dpdk_device_errors;
434 format_function_t format_dpdk_tx_dma_trace;
435 format_function_t format_dpdk_rx_dma_trace;
436 format_function_t format_dpdk_rte_mbuf;
437 format_function_t format_dpdk_rx_rte_mbuf;
438 unformat_function_t unformat_dpdk_log_level;
439 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
440 clib_error_t *unformat_hqos (unformat_input_t * input,
441 dpdk_device_config_hqos_t * hqos);
444 admin_up_down_process (vlib_main_t * vm,
445 vlib_node_runtime_t * rt, vlib_frame_t * f);
447 #endif /* __included_dpdk_h__ */
450 * fd.io coding-style-patch-verification: ON
453 * eval: (c-set-style "gnu")