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>
26 #include <rte_memory.h>
27 #include <rte_memzone.h>
28 #include <rte_tailq.h>
30 #include <rte_per_lcore.h>
31 #include <rte_launch.h>
32 #include <rte_atomic.h>
33 #include <rte_cycles.h>
34 #include <rte_prefetch.h>
35 #include <rte_lcore.h>
36 #include <rte_per_lcore.h>
37 #include <rte_branch_prediction.h>
38 #include <rte_interrupts.h>
40 #include <rte_random.h>
41 #include <rte_debug.h>
42 #include <rte_ether.h>
43 #include <rte_ethdev.h>
45 #include <rte_mempool.h>
47 #include <rte_virtio_net.h>
48 #include <rte_version.h>
49 #include <rte_eth_bond.h>
50 #include <rte_sched.h>
52 #include <vnet/unix/pcap.h>
53 #include <vnet/devices/devices.h>
56 #define always_inline static inline
58 #define always_inline static inline __attribute__ ((__always_inline__))
61 #include <vlib/pci/pci.h>
63 #define NB_MBUF (16<<10)
65 extern vnet_device_class_t dpdk_device_class;
66 extern vlib_node_registration_t dpdk_input_node;
67 extern vlib_node_registration_t handoff_dispatch_node;
69 #define foreach_dpdk_pmd \
70 _ ("net_thunderx", THUNDERX) \
71 _ ("net_e1000_em", E1000EM) \
72 _ ("net_e1000_igb", IGB) \
73 _ ("net_e1000_igb_vf", IGBVF) \
74 _ ("net_ixgbe", IXGBE) \
75 _ ("net_ixgbe_vf", IXGBEVF) \
76 _ ("net_i40e", I40E) \
77 _ ("net_i40e_vf", I40EVF) \
78 _ ("net_virtio", VIRTIO) \
79 _ ("net_enic", ENIC) \
80 _ ("net_vmxnet3", VMXNET3) \
81 _ ("AF_PACKET PMD", AF_PACKET) \
82 _ ("rte_bond_pmd", BOND) \
83 _ ("net_fm10k", FM10K) \
84 _ ("net_cxgbe", CXGBE) \
85 _ ("net_mlx5", MLX5) \
86 _ ("net_dpaa2", DPAA2)
91 #define _(s,f) VNET_DPDK_PMD_##f,
94 VNET_DPDK_PMD_UNKNOWN, /* must be last */
99 VNET_DPDK_PORT_TYPE_ETH_1G,
100 VNET_DPDK_PORT_TYPE_ETH_10G,
101 VNET_DPDK_PORT_TYPE_ETH_40G,
102 VNET_DPDK_PORT_TYPE_ETH_100G,
103 VNET_DPDK_PORT_TYPE_ETH_BOND,
104 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
105 VNET_DPDK_PORT_TYPE_AF_PACKET,
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.
122 struct rte_ring *swq;
124 u64 hqos_field0_slabmask;
125 u32 hqos_field0_slabpos;
126 u32 hqos_field0_slabshr;
127 u64 hqos_field1_slabmask;
128 u32 hqos_field1_slabpos;
129 u32 hqos_field1_slabshr;
130 u64 hqos_field2_slabmask;
131 u32 hqos_field2_slabpos;
132 u32 hqos_field2_slabshr;
133 u32 hqos_tc_table[64];
134 } dpdk_device_hqos_per_worker_thread_t;
138 struct rte_ring **swq;
139 struct rte_mbuf **pkts_enq;
140 struct rte_mbuf **pkts_deq;
141 struct rte_sched_port *hqos;
147 } dpdk_device_hqos_per_hqos_thread_t;
151 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
152 volatile u32 **lockp;
157 u32 vlib_hw_if_index;
158 u32 vlib_sw_if_index;
160 /* next node index if we decide to steal the rx graph arc */
161 u32 per_interface_next_index;
163 /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
164 struct rte_mbuf ***tx_vectors; /* one per worker thread */
165 struct rte_mbuf ***rx_vectors;
167 /* vector of traced contexts, per device */
168 u32 **d_trace_buffers;
174 #define DPDK_DEVICE_FLAG_ADMIN_UP (1 << 0)
175 #define DPDK_DEVICE_FLAG_PROMISC (1 << 1)
176 #define DPDK_DEVICE_FLAG_PMD (1 << 2)
177 #define DPDK_DEVICE_FLAG_PMD_SUPPORTS_PTYPE (1 << 3)
178 #define DPDK_DEVICE_FLAG_MAYBE_MULTISEG (1 << 4)
179 #define DPDK_DEVICE_FLAG_HAVE_SUBIF (1 << 5)
180 #define DPDK_DEVICE_FLAG_HQOS (1 << 6)
183 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
185 u8 *interface_name_suffix;
187 /* number of sub-interfaces */
194 u16 *cpu_socket_id_by_queue;
195 struct rte_eth_conf port_conf;
196 struct rte_eth_txconf tx_conf;
199 dpdk_device_hqos_per_worker_thread_t *hqos_wt;
200 dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
203 u8 af_packet_port_id;
205 struct rte_eth_link link;
206 f64 time_last_link_update;
208 struct rte_eth_stats stats;
209 struct rte_eth_stats last_stats;
210 struct rte_eth_stats last_cleared_stats;
211 struct rte_eth_xstat *xstats;
212 struct rte_eth_xstat *last_cleared_xstats;
213 f64 time_last_stats_update;
214 dpdk_port_type_t port_type;
217 u8 *default_mac_address;
220 #define DPDK_STATS_POLL_INTERVAL (10.0)
221 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
223 #define DPDK_LINK_POLL_INTERVAL (3.0)
224 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
230 } dpdk_device_and_queue_t;
232 #ifndef DPDK_HQOS_DBG_BYPASS
233 #define DPDK_HQOS_DBG_BYPASS 0
236 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
237 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
240 typedef struct dpdk_device_config_hqos_t
243 u32 hqos_thread_valid;
249 u32 pktfield0_slabpos;
250 u32 pktfield1_slabpos;
251 u32 pktfield2_slabpos;
252 u64 pktfield0_slabmask;
253 u64 pktfield1_slabmask;
254 u64 pktfield2_slabmask;
257 struct rte_sched_port_params port;
258 struct rte_sched_subport_params *subport;
259 struct rte_sched_pipe_params *pipe;
261 } dpdk_device_config_hqos_t;
263 int dpdk_hqos_validate_mask (u64 mask, u32 n);
264 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
265 hqos, u32 pipe_profile_id);
266 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
267 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
268 dpdk_device_config_hqos_t * hqos);
269 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
270 struct rte_mbuf **pkts, u32 n_pkts);
272 #define foreach_dpdk_device_config_item \
281 vlib_pci_addr_t pci_addr;
283 u8 vlan_strip_offload;
284 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
285 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
286 #define DPDK_DEVICE_VLAN_STRIP_ON 2
288 #define _(x) uword x;
289 foreach_dpdk_device_config_item
291 clib_bitmap_t * workers;
293 dpdk_device_config_hqos_t hqos;
294 } dpdk_device_config_t;
301 u8 *eal_init_args_str;
304 u8 enable_tcp_udp_checksum;
307 /* Required config parameters */
308 u8 coremask_set_manually;
309 u8 nchannels_set_manually;
313 u8 num_kni; /* while kni_init allows u32, port_id in callback fn is only u8 */
316 * format interface names ala xxxEthernet%d/%d/%d instead of
317 * xxxEthernet%x/%x/%x.
319 u8 interface_name_format_decimal;
321 /* per-device config */
322 dpdk_device_config_t default_devconf;
323 dpdk_device_config_t *dev_confs;
324 uword *device_config_index_by_pci_addr;
326 } dpdk_config_main_t;
328 dpdk_config_main_t dpdk_config_main;
334 dpdk_device_t *devices;
335 dpdk_device_and_queue_t **devices_by_cpu;
336 dpdk_device_and_queue_t **devices_by_hqos_cpu;
338 /* per-thread recycle lists */
341 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
342 u32 buffer_flags_template;
344 /* vlib buffer free list, must be same size as an rte_mbuf */
345 u32 vlib_buffer_free_list_index;
347 /* Ethernet input node index */
348 u32 ethernet_input_node_index;
350 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
352 pcap_main_t pcap_main;
354 u32 pcap_sw_if_index;
355 u32 pcap_pkts_to_capture;
358 uword *dpdk_device_by_kni_port_id;
359 uword *vu_sw_if_index_by_listener_fd;
360 uword *vu_sw_if_index_by_sock_fd;
361 u32 *vu_inactive_interfaces_device_index;
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;
371 /* which cpus are running dpdk-input */
372 int input_cpu_first_index;
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 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 vnet_buffer_needs_dpdk_mb (vlib_buffer_t * b);
422 clib_error_t *dpdk_set_mac_address (vnet_hw_interface_t * hi, char *address);
424 clib_error_t *dpdk_set_mc_filter (vnet_hw_interface_t * hi,
425 struct ether_addr mc_addr_vec[], int naddr);
427 void dpdk_thread_input (dpdk_main_t * dm, dpdk_device_t * xd);
429 clib_error_t *dpdk_port_setup (dpdk_main_t * dm, dpdk_device_t * xd);
431 u32 dpdk_interface_tx_vector (vlib_main_t * vm, u32 dev_instance);
433 struct rte_mbuf *dpdk_replicate_packet_mb (vlib_buffer_t * b);
434 struct rte_mbuf *dpdk_zerocopy_replicate_packet_mb (vlib_buffer_t * b);
436 #define foreach_dpdk_error \
437 _(NONE, "no error") \
438 _(RX_PACKET_ERROR, "Rx packet errors") \
439 _(RX_BAD_FCS, "Rx bad fcs") \
440 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
441 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
442 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
443 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
447 #define _(f,s) DPDK_ERROR_##f,
453 int dpdk_set_stat_poll_interval (f64 interval);
454 int dpdk_set_link_state_poll_interval (f64 interval);
455 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
456 void dpdk_device_lock_init (dpdk_device_t * xd);
457 void dpdk_device_lock_free (dpdk_device_t * xd);
459 void dpdk_rx_trace (dpdk_main_t * dm,
460 vlib_node_runtime_t * node,
462 u16 queue_id, u32 * buffers, uword n_buffers);
464 #define EFD_OPERATION_LESS_THAN 0
465 #define EFD_OPERATION_GREATER_OR_EQUAL 1
467 format_function_t format_dpdk_device_name;
468 format_function_t format_dpdk_device;
469 format_function_t format_dpdk_tx_dma_trace;
470 format_function_t format_dpdk_rx_dma_trace;
471 format_function_t format_dpdk_rte_mbuf;
472 format_function_t format_dpdk_rx_rte_mbuf;
473 unformat_function_t unformat_socket_mem;
474 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
475 clib_error_t *unformat_hqos (unformat_input_t * input,
476 dpdk_device_config_hqos_t * hqos);
479 admin_up_down_process (vlib_main_t * vm,
480 vlib_node_runtime_t * rt, vlib_frame_t * f);
482 #endif /* __included_dpdk_h__ */
485 * fd.io coding-style-patch-verification: ON
488 * eval: (c-set-style "gnu")