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>
43 #include <vnet/unix/pcap.h>
44 #include <vnet/devices/devices.h>
47 #define always_inline static inline
49 #define always_inline static inline __attribute__ ((__always_inline__))
52 #include <vlib/pci/pci.h>
54 #define NB_MBUF (16<<10)
56 extern vnet_device_class_t dpdk_device_class;
57 extern vlib_node_registration_t dpdk_input_node;
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_mlx4", MLX4) \
76 _ ("net_mlx5", MLX5) \
77 _ ("net_dpaa2", DPAA2) \
78 _ ("net_virtio_user", VIRTIO_USER) \
79 _ ("net_vhost", VHOST_ETHER)
84 #define _(s,f) VNET_DPDK_PMD_##f,
87 VNET_DPDK_PMD_UNKNOWN, /* must be last */
92 VNET_DPDK_PORT_TYPE_ETH_1G,
93 VNET_DPDK_PORT_TYPE_ETH_10G,
94 VNET_DPDK_PORT_TYPE_ETH_25G,
95 VNET_DPDK_PORT_TYPE_ETH_40G,
96 VNET_DPDK_PORT_TYPE_ETH_50G,
97 VNET_DPDK_PORT_TYPE_ETH_100G,
98 VNET_DPDK_PORT_TYPE_ETH_BOND,
99 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
100 VNET_DPDK_PORT_TYPE_AF_PACKET,
101 VNET_DPDK_PORT_TYPE_ETH_VF,
102 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
103 VNET_DPDK_PORT_TYPE_VHOST_ETHER,
104 VNET_DPDK_PORT_TYPE_UNKNOWN,
108 * The header for the tx_vector in dpdk_device_t.
109 * Head and tail are indexes into the tx_vector and are of type
110 * u64 so they never overflow.
120 struct rte_ring *swq;
122 u64 hqos_field0_slabmask;
123 u32 hqos_field0_slabpos;
124 u32 hqos_field0_slabshr;
125 u64 hqos_field1_slabmask;
126 u32 hqos_field1_slabpos;
127 u32 hqos_field1_slabshr;
128 u64 hqos_field2_slabmask;
129 u32 hqos_field2_slabpos;
130 u32 hqos_field2_slabshr;
131 u32 hqos_tc_table[64];
132 } dpdk_device_hqos_per_worker_thread_t;
136 struct rte_ring **swq;
137 struct rte_mbuf **pkts_enq;
138 struct rte_mbuf **pkts_deq;
139 struct rte_sched_port *hqos;
145 } dpdk_device_hqos_per_hqos_thread_t;
149 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
150 volatile u32 **lockp;
156 u32 vlib_sw_if_index;
158 /* next node index if we decide to steal the rx graph arc */
159 u32 per_interface_next_index;
161 /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
162 struct rte_mbuf ***tx_vectors; /* one per worker thread */
163 struct rte_mbuf ***rx_vectors;
165 /* vector of traced contexts, per device */
166 u32 **d_trace_buffers;
172 #define DPDK_DEVICE_FLAG_ADMIN_UP (1 << 0)
173 #define DPDK_DEVICE_FLAG_PROMISC (1 << 1)
174 #define DPDK_DEVICE_FLAG_PMD (1 << 2)
175 #define DPDK_DEVICE_FLAG_PMD_INIT_FAIL (1 << 3)
176 #define DPDK_DEVICE_FLAG_MAYBE_MULTISEG (1 << 4)
177 #define DPDK_DEVICE_FLAG_HAVE_SUBIF (1 << 5)
178 #define DPDK_DEVICE_FLAG_HQOS (1 << 6)
179 #define DPDK_DEVICE_FLAG_BOND_SLAVE (1 << 7)
180 #define DPDK_DEVICE_FLAG_BOND_SLAVE_UP (1 << 8)
181 #define DPDK_DEVICE_FLAG_TX_OFFLOAD (1 << 9)
182 #define DPDK_DEVICE_FLAG_INTEL_PHDR_CKSUM (1 << 10)
185 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
187 u8 *interface_name_suffix;
189 /* number of sub-interfaces */
196 u16 *cpu_socket_id_by_queue;
197 u8 *buffer_pool_for_queue;
198 struct rte_eth_conf port_conf;
199 struct rte_eth_txconf tx_conf;
202 dpdk_device_hqos_per_worker_thread_t *hqos_wt;
203 dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
205 /* af_packet or BondEthernet instance number */
208 /* Bonded interface port# of a slave -
209 only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
212 struct rte_eth_link link;
213 f64 time_last_link_update;
215 struct rte_eth_stats stats;
216 struct rte_eth_stats last_stats;
217 struct rte_eth_stats last_cleared_stats;
218 struct rte_eth_xstat *xstats;
219 struct rte_eth_xstat *last_cleared_xstats;
220 f64 time_last_stats_update;
221 dpdk_port_type_t port_type;
224 u8 *default_mac_address;
227 clib_error_t *errors;
230 #define DPDK_STATS_POLL_INTERVAL (10.0)
231 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
233 #define DPDK_LINK_POLL_INTERVAL (3.0)
234 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
240 } dpdk_device_and_queue_t;
242 #ifndef DPDK_HQOS_DBG_BYPASS
243 #define DPDK_HQOS_DBG_BYPASS 0
246 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
247 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
250 typedef struct dpdk_device_config_hqos_t
253 u32 hqos_thread_valid;
259 u32 pktfield0_slabpos;
260 u32 pktfield1_slabpos;
261 u32 pktfield2_slabpos;
262 u64 pktfield0_slabmask;
263 u64 pktfield1_slabmask;
264 u64 pktfield2_slabmask;
267 struct rte_sched_port_params port;
268 struct rte_sched_subport_params *subport;
269 struct rte_sched_pipe_params *pipe;
271 } dpdk_device_config_hqos_t;
273 int dpdk_hqos_validate_mask (u64 mask, u32 n);
274 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
275 hqos, u32 pipe_profile_id);
276 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
277 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
278 dpdk_device_config_hqos_t * hqos);
279 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
280 struct rte_mbuf **pkts, u32 n_pkts);
282 #define foreach_dpdk_device_config_item \
291 vlib_pci_addr_t pci_addr;
293 u8 vlan_strip_offload;
294 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
295 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
296 #define DPDK_DEVICE_VLAN_STRIP_ON 2
298 #define _(x) uword x;
299 foreach_dpdk_device_config_item
301 clib_bitmap_t * workers;
303 dpdk_device_config_hqos_t hqos;
304 } dpdk_device_config_t;
311 u8 *eal_init_args_str;
314 u8 enable_tcp_udp_checksum;
316 /* Required config parameters */
317 u8 coremask_set_manually;
318 u8 nchannels_set_manually;
324 * format interface names ala xxxEthernet%d/%d/%d instead of
325 * xxxEthernet%x/%x/%x.
327 u8 interface_name_format_decimal;
329 /* per-device config */
330 dpdk_device_config_t default_devconf;
331 dpdk_device_config_t *dev_confs;
332 uword *device_config_index_by_pci_addr;
334 } dpdk_config_main_t;
336 extern dpdk_config_main_t dpdk_config_main;
342 dpdk_device_t *devices;
343 dpdk_device_and_queue_t **devices_by_hqos_cpu;
345 /* per-thread recycle lists */
348 /* per-thread buffer templates */
349 vlib_buffer_t *buffer_templates;
351 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
352 u32 buffer_flags_template;
354 /* vlib buffer free list, must be same size as an rte_mbuf */
355 u32 vlib_buffer_free_list_index;
357 /* Ethernet input node index */
358 u32 ethernet_input_node_index;
360 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
362 pcap_main_t pcap_main;
364 u32 pcap_sw_if_index;
365 u32 pcap_pkts_to_capture;
368 * flag indicating that a posted admin up/down
369 * (via post_sw_interface_set_flags) is in progress
371 u8 admin_up_down_in_progress;
375 /* which cpus are running I/O TX */
376 int hqos_cpu_first_index;
379 /* control interval of dpdk link state and stat polling */
380 f64 link_state_poll_interval;
381 f64 stat_poll_interval;
383 /* Sleep for this many usec after each device poll */
387 vlib_main_t *vlib_main;
388 vnet_main_t *vnet_main;
389 dpdk_config_main_t *conf;
392 struct rte_mempool **pktmbuf_pools;
394 /* API message ID base */
398 extern dpdk_main_t dpdk_main;
406 /* Copy of VLIB buffer; packet data stored in pre_data. */
407 vlib_buffer_t buffer;
408 } dpdk_tx_dma_trace_t;
416 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
417 u8 data[256]; /* First 256 data bytes, used for hexdump */
418 } dpdk_rx_dma_trace_t;
420 void dpdk_device_setup (dpdk_device_t * xd);
421 void dpdk_device_start (dpdk_device_t * xd);
422 void dpdk_device_stop (dpdk_device_t * xd);
424 #if DPDK_VOID_CALLBACK
425 void dpdk_port_state_callback (uint8_t port_id,
426 enum rte_eth_event_type type, void *param);
428 int dpdk_port_state_callback (uint8_t port_id,
429 enum rte_eth_event_type type,
430 void *param, void *ret_param);
433 #define foreach_dpdk_error \
434 _(NONE, "no error") \
435 _(RX_PACKET_ERROR, "Rx packet errors") \
436 _(RX_BAD_FCS, "Rx bad fcs") \
437 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
438 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
439 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
440 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
444 #define _(f,s) DPDK_ERROR_##f,
450 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
452 format_function_t format_dpdk_device_name;
453 format_function_t format_dpdk_device;
454 format_function_t format_dpdk_device_errors;
455 format_function_t format_dpdk_tx_dma_trace;
456 format_function_t format_dpdk_rx_dma_trace;
457 format_function_t format_dpdk_rte_mbuf;
458 format_function_t format_dpdk_rx_rte_mbuf;
459 unformat_function_t unformat_dpdk_log_level;
460 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
461 clib_error_t *unformat_hqos (unformat_input_t * input,
462 dpdk_device_config_hqos_t * hqos);
465 admin_up_down_process (vlib_main_t * vm,
466 vlib_node_runtime_t * rt, vlib_frame_t * f);
468 clib_error_t *dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
472 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
473 void dpdk_buffer_poison_trajectory_all (void);
476 #endif /* __included_dpdk_h__ */
479 * fd.io coding-style-patch-verification: ON
482 * eval: (c-set-style "gnu")