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 #if RTE_VERSION >= RTE_VERSION_NUM(17, 11, 0, 0)
43 #include <rte_bus_pci.h>
46 #include <vnet/unix/pcap.h>
47 #include <vnet/devices/devices.h>
50 #define always_inline static inline
52 #define always_inline static inline __attribute__ ((__always_inline__))
55 #include <vlib/pci/pci.h>
57 #define NB_MBUF (16<<10)
59 extern vnet_device_class_t dpdk_device_class;
60 extern vlib_node_registration_t dpdk_input_node;
62 #define foreach_dpdk_pmd \
63 _ ("net_thunderx", THUNDERX) \
64 _ ("net_e1000_em", E1000EM) \
65 _ ("net_e1000_igb", IGB) \
66 _ ("net_e1000_igb_vf", IGBVF) \
67 _ ("net_ixgbe", IXGBE) \
68 _ ("net_ixgbe_vf", IXGBEVF) \
69 _ ("net_i40e", I40E) \
70 _ ("net_i40e_vf", I40EVF) \
71 _ ("net_virtio", VIRTIO) \
72 _ ("net_enic", ENIC) \
73 _ ("net_vmxnet3", VMXNET3) \
74 _ ("AF_PACKET PMD", AF_PACKET) \
75 _ ("net_bonding", BOND) \
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)
87 #define _(s,f) VNET_DPDK_PMD_##f,
90 VNET_DPDK_PMD_UNKNOWN, /* must be last */
95 VNET_DPDK_PORT_TYPE_ETH_1G,
96 VNET_DPDK_PORT_TYPE_ETH_10G,
97 VNET_DPDK_PORT_TYPE_ETH_25G,
98 VNET_DPDK_PORT_TYPE_ETH_40G,
99 VNET_DPDK_PORT_TYPE_ETH_50G,
100 VNET_DPDK_PORT_TYPE_ETH_100G,
101 VNET_DPDK_PORT_TYPE_ETH_BOND,
102 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
103 VNET_DPDK_PORT_TYPE_AF_PACKET,
104 VNET_DPDK_PORT_TYPE_ETH_VF,
105 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
106 VNET_DPDK_PORT_TYPE_VHOST_ETHER,
107 VNET_DPDK_PORT_TYPE_UNKNOWN,
111 * The header for the tx_vector in dpdk_device_t.
112 * Head and tail are indexes into the tx_vector and are of type
113 * u64 so they never overflow.
121 #if RTE_VERSION < RTE_VERSION_NUM(17, 11, 0, 0)
122 typedef uint8_t dpdk_portid_t;
124 typedef uint16_t dpdk_portid_t;
129 struct rte_ring *swq;
131 u64 hqos_field0_slabmask;
132 u32 hqos_field0_slabpos;
133 u32 hqos_field0_slabshr;
134 u64 hqos_field1_slabmask;
135 u32 hqos_field1_slabpos;
136 u32 hqos_field1_slabshr;
137 u64 hqos_field2_slabmask;
138 u32 hqos_field2_slabpos;
139 u32 hqos_field2_slabshr;
140 u32 hqos_tc_table[64];
141 } dpdk_device_hqos_per_worker_thread_t;
145 struct rte_ring **swq;
146 struct rte_mbuf **pkts_enq;
147 struct rte_mbuf **pkts_deq;
148 struct rte_sched_port *hqos;
154 } dpdk_device_hqos_per_hqos_thread_t;
158 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
159 volatile u32 **lockp;
162 dpdk_portid_t device_index;
165 u32 vlib_sw_if_index;
167 /* next node index if we decide to steal the rx graph arc */
168 u32 per_interface_next_index;
170 /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
171 struct rte_mbuf ***tx_vectors; /* one per worker thread */
172 struct rte_mbuf ***rx_vectors;
174 /* vector of traced contexts, per device */
175 u32 **d_trace_buffers;
181 #define DPDK_DEVICE_FLAG_ADMIN_UP (1 << 0)
182 #define DPDK_DEVICE_FLAG_PROMISC (1 << 1)
183 #define DPDK_DEVICE_FLAG_PMD (1 << 2)
184 #define DPDK_DEVICE_FLAG_PMD_INIT_FAIL (1 << 3)
185 #define DPDK_DEVICE_FLAG_MAYBE_MULTISEG (1 << 4)
186 #define DPDK_DEVICE_FLAG_HAVE_SUBIF (1 << 5)
187 #define DPDK_DEVICE_FLAG_HQOS (1 << 6)
188 #define DPDK_DEVICE_FLAG_BOND_SLAVE (1 << 7)
189 #define DPDK_DEVICE_FLAG_BOND_SLAVE_UP (1 << 8)
190 #define DPDK_DEVICE_FLAG_TX_OFFLOAD (1 << 9)
191 #define DPDK_DEVICE_FLAG_INTEL_PHDR_CKSUM (1 << 10)
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 u8 *buffer_pool_for_queue;
207 struct rte_eth_conf port_conf;
208 struct rte_eth_txconf tx_conf;
211 dpdk_device_hqos_per_worker_thread_t *hqos_wt;
212 dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
214 /* af_packet or BondEthernet instance number */
215 dpdk_portid_t port_id;
217 /* Bonded interface port# of a slave -
218 only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
219 dpdk_portid_t bond_port;
221 struct rte_eth_link link;
222 f64 time_last_link_update;
224 struct rte_eth_stats stats;
225 struct rte_eth_stats last_stats;
226 struct rte_eth_stats last_cleared_stats;
227 struct rte_eth_xstat *xstats;
228 struct rte_eth_xstat *last_cleared_xstats;
229 f64 time_last_stats_update;
230 dpdk_port_type_t port_type;
233 u8 *default_mac_address;
236 clib_error_t *errors;
239 #define DPDK_STATS_POLL_INTERVAL (10.0)
240 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
242 #define DPDK_LINK_POLL_INTERVAL (3.0)
243 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
249 } dpdk_device_and_queue_t;
251 #ifndef DPDK_HQOS_DBG_BYPASS
252 #define DPDK_HQOS_DBG_BYPASS 0
255 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
256 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
259 typedef struct dpdk_device_config_hqos_t
262 u32 hqos_thread_valid;
268 u32 pktfield0_slabpos;
269 u32 pktfield1_slabpos;
270 u32 pktfield2_slabpos;
271 u64 pktfield0_slabmask;
272 u64 pktfield1_slabmask;
273 u64 pktfield2_slabmask;
276 struct rte_sched_port_params port;
277 struct rte_sched_subport_params *subport;
278 struct rte_sched_pipe_params *pipe;
280 } dpdk_device_config_hqos_t;
282 int dpdk_hqos_validate_mask (u64 mask, u32 n);
283 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
284 hqos, u32 pipe_profile_id);
285 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
286 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
287 dpdk_device_config_hqos_t * hqos);
288 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
289 struct rte_mbuf **pkts, u32 n_pkts);
291 #define foreach_dpdk_device_config_item \
300 vlib_pci_addr_t pci_addr;
302 u8 vlan_strip_offload;
303 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
304 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
305 #define DPDK_DEVICE_VLAN_STRIP_ON 2
307 #define _(x) uword x;
308 foreach_dpdk_device_config_item
310 clib_bitmap_t * workers;
312 dpdk_device_config_hqos_t hqos;
313 } dpdk_device_config_t;
320 u8 *eal_init_args_str;
323 u8 enable_tcp_udp_checksum;
325 /* Required config parameters */
326 u8 coremask_set_manually;
327 u8 nchannels_set_manually;
333 * format interface names ala xxxEthernet%d/%d/%d instead of
334 * xxxEthernet%x/%x/%x.
336 u8 interface_name_format_decimal;
338 /* per-device config */
339 dpdk_device_config_t default_devconf;
340 dpdk_device_config_t *dev_confs;
341 uword *device_config_index_by_pci_addr;
343 } dpdk_config_main_t;
345 extern dpdk_config_main_t dpdk_config_main;
351 dpdk_device_t *devices;
352 dpdk_device_and_queue_t **devices_by_hqos_cpu;
354 /* per-thread recycle lists */
357 /* per-thread buffer templates */
358 vlib_buffer_t *buffer_templates;
360 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
361 u32 buffer_flags_template;
363 /* vlib buffer free list, must be same size as an rte_mbuf */
364 u32 vlib_buffer_free_list_index;
366 /* Ethernet input node index */
367 u32 ethernet_input_node_index;
369 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
371 pcap_main_t pcap_main;
373 u32 pcap_sw_if_index;
374 u32 pcap_pkts_to_capture;
377 * flag indicating that a posted admin up/down
378 * (via post_sw_interface_set_flags) is in progress
380 u8 admin_up_down_in_progress;
384 /* which cpus are running I/O TX */
385 int hqos_cpu_first_index;
388 /* control interval of dpdk link state and stat polling */
389 f64 link_state_poll_interval;
390 f64 stat_poll_interval;
392 /* Sleep for this many usec after each device poll */
396 vlib_main_t *vlib_main;
397 vnet_main_t *vnet_main;
398 dpdk_config_main_t *conf;
401 struct rte_mempool **pktmbuf_pools;
403 /* API message ID base */
407 extern dpdk_main_t dpdk_main;
415 /* Copy of VLIB buffer; packet data stored in pre_data. */
416 vlib_buffer_t buffer;
417 u8 data[256]; /* First 256 data bytes, used for hexdump */
418 } dpdk_tx_dma_trace_t;
426 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
427 u8 data[256]; /* First 256 data bytes, used for hexdump */
428 } dpdk_rx_dma_trace_t;
430 void dpdk_device_setup (dpdk_device_t * xd);
431 void dpdk_device_start (dpdk_device_t * xd);
432 void dpdk_device_stop (dpdk_device_t * xd);
434 int dpdk_port_state_callback (dpdk_portid_t port_id,
435 enum rte_eth_event_type type,
436 void *param, void *ret_param);
438 #define foreach_dpdk_error \
439 _(NONE, "no error") \
440 _(RX_PACKET_ERROR, "Rx packet errors") \
441 _(RX_BAD_FCS, "Rx bad fcs") \
442 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
443 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
444 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
445 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
449 #define _(f,s) DPDK_ERROR_##f,
455 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
457 format_function_t format_dpdk_device_name;
458 format_function_t format_dpdk_device;
459 format_function_t format_dpdk_device_errors;
460 format_function_t format_dpdk_tx_dma_trace;
461 format_function_t format_dpdk_rx_dma_trace;
462 format_function_t format_dpdk_rte_mbuf;
463 format_function_t format_dpdk_rx_rte_mbuf;
464 unformat_function_t unformat_dpdk_log_level;
465 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
466 clib_error_t *unformat_hqos (unformat_input_t * input,
467 dpdk_device_config_hqos_t * hqos);
470 admin_up_down_process (vlib_main_t * vm,
471 vlib_node_runtime_t * rt, vlib_frame_t * f);
473 clib_error_t *dpdk_pool_create (vlib_main_t * vm, u8 * pool_name,
474 u32 elt_size, u32 num_elts,
475 u32 pool_priv_size, u16 cache_size, u8 numa,
476 struct rte_mempool **_mp,
477 vlib_physmem_region_index_t * pri);
479 clib_error_t *dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
483 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
484 void dpdk_buffer_poison_trajectory_all (void);
487 #endif /* __included_dpdk_h__ */
490 * fd.io coding-style-patch-verification: ON
493 * eval: (c-set-style "gnu")