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 <rte_bus_pci.h>
44 #include <vnet/unix/pcap.h>
45 #include <vnet/devices/devices.h>
48 #define always_inline static inline
50 #define always_inline static inline __attribute__ ((__always_inline__))
53 #include <vlib/pci/pci.h>
55 #define NB_MBUF (16<<10)
57 extern vnet_device_class_t dpdk_device_class;
58 extern vlib_node_registration_t dpdk_input_node;
60 #define foreach_dpdk_pmd \
61 _ ("net_thunderx", THUNDERX) \
62 _ ("net_e1000_em", E1000EM) \
63 _ ("net_e1000_igb", IGB) \
64 _ ("net_e1000_igb_vf", IGBVF) \
65 _ ("net_ixgbe", IXGBE) \
66 _ ("net_ixgbe_vf", IXGBEVF) \
67 _ ("net_i40e", I40E) \
68 _ ("net_i40e_vf", I40EVF) \
69 _ ("net_virtio", VIRTIO) \
70 _ ("net_enic", ENIC) \
71 _ ("net_vmxnet3", VMXNET3) \
72 _ ("AF_PACKET PMD", AF_PACKET) \
73 _ ("net_bonding", BOND) \
74 _ ("net_fm10k", FM10K) \
75 _ ("net_cxgbe", CXGBE) \
76 _ ("net_mlx4", MLX4) \
77 _ ("net_mlx5", MLX5) \
78 _ ("net_dpaa2", DPAA2) \
79 _ ("net_virtio_user", VIRTIO_USER) \
80 _ ("net_vhost", VHOST_ETHER) \
86 #define _(s,f) VNET_DPDK_PMD_##f,
89 VNET_DPDK_PMD_UNKNOWN, /* must be last */
94 VNET_DPDK_PORT_TYPE_ETH_1G,
95 VNET_DPDK_PORT_TYPE_ETH_10G,
96 VNET_DPDK_PORT_TYPE_ETH_25G,
97 VNET_DPDK_PORT_TYPE_ETH_40G,
98 VNET_DPDK_PORT_TYPE_ETH_50G,
99 VNET_DPDK_PORT_TYPE_ETH_100G,
100 VNET_DPDK_PORT_TYPE_ETH_BOND,
101 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
102 VNET_DPDK_PORT_TYPE_AF_PACKET,
103 VNET_DPDK_PORT_TYPE_ETH_VF,
104 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
105 VNET_DPDK_PORT_TYPE_VHOST_ETHER,
106 VNET_DPDK_PORT_TYPE_UNKNOWN,
110 * The header for the tx_vector in dpdk_device_t.
111 * Head and tail are indexes into the tx_vector and are of type
112 * u64 so they never overflow.
120 typedef uint16_t dpdk_portid_t;
124 struct rte_ring *swq;
126 u64 hqos_field0_slabmask;
127 u32 hqos_field0_slabpos;
128 u32 hqos_field0_slabshr;
129 u64 hqos_field1_slabmask;
130 u32 hqos_field1_slabpos;
131 u32 hqos_field1_slabshr;
132 u64 hqos_field2_slabmask;
133 u32 hqos_field2_slabpos;
134 u32 hqos_field2_slabshr;
135 u32 hqos_tc_table[64];
136 } dpdk_device_hqos_per_worker_thread_t;
140 struct rte_ring **swq;
141 struct rte_mbuf **pkts_enq;
142 struct rte_mbuf **pkts_deq;
143 struct rte_sched_port *hqos;
149 } dpdk_device_hqos_per_hqos_thread_t;
153 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
154 volatile u32 **lockp;
157 dpdk_portid_t device_index;
160 u32 vlib_sw_if_index;
162 /* next node index if we decide to steal the rx graph arc */
163 u32 per_interface_next_index;
165 /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
166 struct rte_mbuf ***tx_vectors; /* one per worker thread */
167 struct rte_mbuf ***rx_vectors;
173 #define DPDK_DEVICE_FLAG_ADMIN_UP (1 << 0)
174 #define DPDK_DEVICE_FLAG_PROMISC (1 << 1)
175 #define DPDK_DEVICE_FLAG_PMD (1 << 2)
176 #define DPDK_DEVICE_FLAG_PMD_INIT_FAIL (1 << 3)
177 #define DPDK_DEVICE_FLAG_MAYBE_MULTISEG (1 << 4)
178 #define DPDK_DEVICE_FLAG_HAVE_SUBIF (1 << 5)
179 #define DPDK_DEVICE_FLAG_HQOS (1 << 6)
180 #define DPDK_DEVICE_FLAG_BOND_SLAVE (1 << 7)
181 #define DPDK_DEVICE_FLAG_BOND_SLAVE_UP (1 << 8)
182 #define DPDK_DEVICE_FLAG_TX_OFFLOAD (1 << 9)
183 #define DPDK_DEVICE_FLAG_INTEL_PHDR_CKSUM (1 << 10)
186 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
188 u8 *interface_name_suffix;
190 /* number of sub-interfaces */
197 u16 *cpu_socket_id_by_queue;
198 u8 *buffer_pool_for_queue;
199 struct rte_eth_conf port_conf;
200 struct rte_eth_txconf tx_conf;
203 dpdk_device_hqos_per_worker_thread_t *hqos_wt;
204 dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
206 /* af_packet or BondEthernet instance number */
207 dpdk_portid_t port_id;
209 /* Bonded interface port# of a slave -
210 only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
211 dpdk_portid_t bond_port;
213 struct rte_eth_link link;
214 f64 time_last_link_update;
216 struct rte_eth_stats stats;
217 struct rte_eth_stats last_stats;
218 struct rte_eth_stats last_cleared_stats;
219 struct rte_eth_xstat *xstats;
220 struct rte_eth_xstat *last_cleared_xstats;
221 f64 time_last_stats_update;
222 dpdk_port_type_t port_type;
225 u8 *default_mac_address;
228 clib_error_t *errors;
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;
316 u8 no_tx_checksum_offload;
318 /* Required config parameters */
319 u8 coremask_set_manually;
320 u8 nchannels_set_manually;
326 * format interface names ala xxxEthernet%d/%d/%d instead of
327 * xxxEthernet%x/%x/%x.
329 u8 interface_name_format_decimal;
331 /* per-device config */
332 dpdk_device_config_t default_devconf;
333 dpdk_device_config_t *dev_confs;
334 uword *device_config_index_by_pci_addr;
336 } dpdk_config_main_t;
338 extern dpdk_config_main_t dpdk_config_main;
344 dpdk_device_t *devices;
345 dpdk_device_and_queue_t **devices_by_hqos_cpu;
347 /* per-thread recycle lists */
350 /* per-thread buffer templates */
351 vlib_buffer_t *buffer_templates;
353 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
354 u32 buffer_flags_template;
356 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
358 pcap_main_t pcap_main;
360 u32 pcap_sw_if_index;
361 u32 pcap_pkts_to_capture;
364 * flag indicating that a posted admin up/down
365 * (via post_sw_interface_set_flags) is in progress
367 u8 admin_up_down_in_progress;
369 /* which cpus are running I/O TX */
370 int hqos_cpu_first_index;
373 /* control interval of dpdk link state and stat polling */
374 f64 link_state_poll_interval;
375 f64 stat_poll_interval;
377 /* Sleep for this many usec after each device poll */
381 vlib_main_t *vlib_main;
382 vnet_main_t *vnet_main;
383 dpdk_config_main_t *conf;
386 struct rte_mempool **pktmbuf_pools;
388 /* API message ID base */
392 extern dpdk_main_t dpdk_main;
400 /* Copy of VLIB buffer; packet data stored in pre_data. */
401 vlib_buffer_t buffer;
402 u8 data[256]; /* First 256 data bytes, used for hexdump */
403 } dpdk_tx_dma_trace_t;
411 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
412 u8 data[256]; /* First 256 data bytes, used for hexdump */
413 } dpdk_rx_dma_trace_t;
415 void dpdk_device_setup (dpdk_device_t * xd);
416 void dpdk_device_start (dpdk_device_t * xd);
417 void dpdk_device_stop (dpdk_device_t * xd);
419 int dpdk_port_state_callback (dpdk_portid_t port_id,
420 enum rte_eth_event_type type,
421 void *param, void *ret_param);
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_device_errors;
445 format_function_t format_dpdk_tx_dma_trace;
446 format_function_t format_dpdk_rx_dma_trace;
447 format_function_t format_dpdk_rte_mbuf;
448 format_function_t format_dpdk_rx_rte_mbuf;
449 unformat_function_t unformat_dpdk_log_level;
450 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
451 clib_error_t *unformat_hqos (unformat_input_t * input,
452 dpdk_device_config_hqos_t * hqos);
455 admin_up_down_process (vlib_main_t * vm,
456 vlib_node_runtime_t * rt, vlib_frame_t * f);
458 clib_error_t *dpdk_pool_create (vlib_main_t * vm, u8 * pool_name,
459 u32 elt_size, u32 num_elts,
460 u32 pool_priv_size, u16 cache_size, u8 numa,
461 struct rte_mempool **_mp,
462 vlib_physmem_region_index_t * pri);
464 clib_error_t *dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
468 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
469 void dpdk_buffer_poison_trajectory_all (void);
472 #endif /* __included_dpdk_h__ */
475 * fd.io coding-style-patch-verification: ON
478 * eval: (c-set-style "gnu")