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_2_5G,
96 VNET_DPDK_PORT_TYPE_ETH_5G,
97 VNET_DPDK_PORT_TYPE_ETH_10G,
98 VNET_DPDK_PORT_TYPE_ETH_20G,
99 VNET_DPDK_PORT_TYPE_ETH_25G,
100 VNET_DPDK_PORT_TYPE_ETH_40G,
101 VNET_DPDK_PORT_TYPE_ETH_50G,
102 VNET_DPDK_PORT_TYPE_ETH_56G,
103 VNET_DPDK_PORT_TYPE_ETH_100G,
104 VNET_DPDK_PORT_TYPE_ETH_BOND,
105 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
106 VNET_DPDK_PORT_TYPE_AF_PACKET,
107 VNET_DPDK_PORT_TYPE_ETH_VF,
108 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
109 VNET_DPDK_PORT_TYPE_VHOST_ETHER,
110 VNET_DPDK_PORT_TYPE_UNKNOWN,
114 * The header for the tx_vector in dpdk_device_t.
115 * Head and tail are indexes into the tx_vector and are of type
116 * u64 so they never overflow.
124 typedef uint16_t dpdk_portid_t;
128 struct rte_ring *swq;
130 u64 hqos_field0_slabmask;
131 u32 hqos_field0_slabpos;
132 u32 hqos_field0_slabshr;
133 u64 hqos_field1_slabmask;
134 u32 hqos_field1_slabpos;
135 u32 hqos_field1_slabshr;
136 u64 hqos_field2_slabmask;
137 u32 hqos_field2_slabpos;
138 u32 hqos_field2_slabshr;
139 u32 hqos_tc_table[64];
140 } dpdk_device_hqos_per_worker_thread_t;
144 struct rte_ring **swq;
145 struct rte_mbuf **pkts_enq;
146 struct rte_mbuf **pkts_deq;
147 struct rte_sched_port *hqos;
153 } dpdk_device_hqos_per_hqos_thread_t;
155 #define foreach_dpdk_device_flags \
156 _( 0, ADMIN_UP, "admin-up") \
157 _( 1, PROMISC, "promisc") \
159 _( 3, PMD_INIT_FAIL, "pmd-init-fail") \
160 _( 4, MAYBE_MULTISEG, "maybe-multiseg") \
161 _( 5, HAVE_SUBIF, "subif") \
162 _( 6, HQOS, "hqos") \
163 _( 7, BOND_SLAVE, "bond-slave") \
164 _( 8, BOND_SLAVE_UP, "bond-slave-up") \
165 _( 9, TX_OFFLOAD, "tx-offload") \
166 _(10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
170 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
171 foreach_dpdk_device_flags
177 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
178 volatile u32 **lockp;
181 dpdk_portid_t device_index;
184 u32 vlib_sw_if_index;
186 /* next node index if we decide to steal the rx graph arc */
187 u32 per_interface_next_index;
189 /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
190 struct rte_mbuf ***tx_vectors; /* one per worker thread */
191 struct rte_mbuf ***rx_vectors;
199 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
201 u8 *interface_name_suffix;
203 /* number of sub-interfaces */
210 u16 *cpu_socket_id_by_queue;
211 u8 *buffer_pool_for_queue;
212 struct rte_eth_conf port_conf;
213 struct rte_eth_txconf tx_conf;
216 dpdk_device_hqos_per_worker_thread_t *hqos_wt;
217 dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
219 /* af_packet or BondEthernet instance number */
220 dpdk_portid_t port_id;
222 /* Bonded interface port# of a slave -
223 only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
224 dpdk_portid_t bond_port;
226 struct rte_eth_link link;
227 f64 time_last_link_update;
229 struct rte_eth_stats stats;
230 struct rte_eth_stats last_stats;
231 struct rte_eth_stats last_cleared_stats;
232 struct rte_eth_xstat *xstats;
233 struct rte_eth_xstat *last_cleared_xstats;
234 f64 time_last_stats_update;
235 dpdk_port_type_t port_type;
238 u8 *default_mac_address;
241 clib_error_t *errors;
244 #define DPDK_STATS_POLL_INTERVAL (10.0)
245 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
247 #define DPDK_LINK_POLL_INTERVAL (3.0)
248 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
254 } dpdk_device_and_queue_t;
256 #ifndef DPDK_HQOS_DBG_BYPASS
257 #define DPDK_HQOS_DBG_BYPASS 0
260 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
261 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
264 typedef struct dpdk_device_config_hqos_t
267 u32 hqos_thread_valid;
273 u32 pktfield0_slabpos;
274 u32 pktfield1_slabpos;
275 u32 pktfield2_slabpos;
276 u64 pktfield0_slabmask;
277 u64 pktfield1_slabmask;
278 u64 pktfield2_slabmask;
281 struct rte_sched_port_params port;
282 struct rte_sched_subport_params *subport;
283 struct rte_sched_pipe_params *pipe;
285 } dpdk_device_config_hqos_t;
287 int dpdk_hqos_validate_mask (u64 mask, u32 n);
288 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
289 hqos, u32 pipe_profile_id);
290 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
291 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
292 dpdk_device_config_hqos_t * hqos);
293 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
294 struct rte_mbuf **pkts, u32 n_pkts);
296 #define foreach_dpdk_device_config_item \
305 vlib_pci_addr_t pci_addr;
307 u8 vlan_strip_offload;
308 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
309 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
310 #define DPDK_DEVICE_VLAN_STRIP_ON 2
312 #define _(x) uword x;
313 foreach_dpdk_device_config_item
315 clib_bitmap_t * workers;
317 dpdk_device_config_hqos_t hqos;
318 } dpdk_device_config_t;
325 u8 *eal_init_args_str;
328 u8 enable_tcp_udp_checksum;
329 u8 no_tx_checksum_offload;
331 /* Required config parameters */
332 u8 coremask_set_manually;
333 u8 nchannels_set_manually;
339 * format interface names ala xxxEthernet%d/%d/%d instead of
340 * xxxEthernet%x/%x/%x.
342 u8 interface_name_format_decimal;
344 /* per-device config */
345 dpdk_device_config_t default_devconf;
346 dpdk_device_config_t *dev_confs;
347 uword *device_config_index_by_pci_addr;
349 } dpdk_config_main_t;
351 extern dpdk_config_main_t dpdk_config_main;
357 dpdk_device_t *devices;
358 dpdk_device_and_queue_t **devices_by_hqos_cpu;
360 /* per-thread recycle lists */
363 /* per-thread buffer templates */
364 vlib_buffer_t *buffer_templates;
366 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
367 u32 buffer_flags_template;
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;
382 /* which cpus are running I/O TX */
383 int hqos_cpu_first_index;
386 /* control interval of dpdk link state and stat polling */
387 f64 link_state_poll_interval;
388 f64 stat_poll_interval;
390 /* Sleep for this many usec after each device poll */
394 vlib_main_t *vlib_main;
395 vnet_main_t *vnet_main;
396 dpdk_config_main_t *conf;
399 struct rte_mempool **pktmbuf_pools;
401 /* API message ID base */
405 vlib_log_class_t log_default;
408 extern dpdk_main_t dpdk_main;
416 /* Copy of VLIB buffer; packet data stored in pre_data. */
417 vlib_buffer_t buffer;
418 u8 data[256]; /* First 256 data bytes, used for hexdump */
419 } dpdk_tx_dma_trace_t;
427 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
428 u8 data[256]; /* First 256 data bytes, used for hexdump */
429 } dpdk_rx_dma_trace_t;
431 void dpdk_device_setup (dpdk_device_t * xd);
432 void dpdk_device_start (dpdk_device_t * xd);
433 void dpdk_device_stop (dpdk_device_t * xd);
435 int dpdk_port_state_callback (dpdk_portid_t port_id,
436 enum rte_eth_event_type type,
437 void *param, void *ret_param);
439 #define foreach_dpdk_error \
440 _(NONE, "no error") \
441 _(RX_PACKET_ERROR, "Rx packet errors") \
442 _(RX_BAD_FCS, "Rx bad fcs") \
443 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
444 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
445 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
446 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
450 #define _(f,s) DPDK_ERROR_##f,
456 #define dpdk_log_err(...) \
457 vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
458 #define dpdk_log_warn(...) \
459 vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
460 #define dpdk_log_notice(...) \
461 vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
462 #define dpdk_log_info(...) \
463 vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
465 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
467 format_function_t format_dpdk_device_name;
468 format_function_t format_dpdk_device;
469 format_function_t format_dpdk_device_errors;
470 format_function_t format_dpdk_tx_dma_trace;
471 format_function_t format_dpdk_rx_dma_trace;
472 format_function_t format_dpdk_rte_mbuf;
473 format_function_t format_dpdk_rx_rte_mbuf;
474 unformat_function_t unformat_dpdk_log_level;
475 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
476 clib_error_t *unformat_hqos (unformat_input_t * input,
477 dpdk_device_config_hqos_t * hqos);
480 admin_up_down_process (vlib_main_t * vm,
481 vlib_node_runtime_t * rt, vlib_frame_t * f);
483 clib_error_t *dpdk_pool_create (vlib_main_t * vm, u8 * pool_name,
484 u32 elt_size, u32 num_elts,
485 u32 pool_priv_size, u16 cache_size, u8 numa,
486 struct rte_mempool **_mp,
487 vlib_physmem_region_index_t * pri);
489 clib_error_t *dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
493 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
494 void dpdk_buffer_poison_trajectory_all (void);
497 #endif /* __included_dpdk_h__ */
500 * fd.io coding-style-patch-verification: ON
503 * eval: (c-set-style "gnu")