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 #define ALLOW_EXPERIMENTAL_API
23 #include <rte_config.h>
25 #include <rte_common.h>
27 #include <rte_memory.h>
29 #include <rte_per_lcore.h>
30 #include <rte_cycles.h>
31 #include <rte_lcore.h>
32 #include <rte_per_lcore.h>
33 #include <rte_interrupts.h>
35 #include <rte_ether.h>
36 #include <rte_ethdev.h>
38 #include <rte_mempool.h>
40 #include <rte_version.h>
41 #include <rte_eth_bond.h>
42 #include <rte_sched.h>
44 #include <rte_bus_pci.h>
47 #include <vnet/unix/pcap.h>
48 #include <vnet/devices/devices.h>
51 #define always_inline static inline
53 #define always_inline static inline __attribute__ ((__always_inline__))
56 #include <vlib/pci/pci.h>
57 #include <vnet/flow/flow.h>
59 #define NB_MBUF (16<<10)
61 extern vnet_device_class_t dpdk_device_class;
62 extern vlib_node_registration_t dpdk_input_node;
63 extern vlib_node_registration_t admin_up_down_process_node;
65 #define foreach_dpdk_pmd \
66 _ ("net_thunderx", THUNDERX) \
67 _ ("net_e1000_em", E1000EM) \
68 _ ("net_e1000_igb", IGB) \
69 _ ("net_e1000_igb_vf", IGBVF) \
70 _ ("net_ixgbe", IXGBE) \
71 _ ("net_ixgbe_vf", IXGBEVF) \
72 _ ("net_i40e", I40E) \
73 _ ("net_i40e_vf", I40EVF) \
74 _ ("net_virtio", VIRTIO) \
75 _ ("net_enic", ENIC) \
76 _ ("net_vmxnet3", VMXNET3) \
77 _ ("AF_PACKET PMD", AF_PACKET) \
78 _ ("net_bonding", BOND) \
79 _ ("net_fm10k", FM10K) \
80 _ ("net_cxgbe", CXGBE) \
81 _ ("net_mlx4", MLX4) \
82 _ ("net_mlx5", MLX5) \
83 _ ("net_dpaa2", DPAA2) \
84 _ ("net_virtio_user", VIRTIO_USER) \
85 _ ("net_vhost", VHOST_ETHER) \
87 _ ("net_failsafe", FAILSAFE) \
88 _ ("net_liovf", LIOVF_ETHER) \
94 #define _(s,f) VNET_DPDK_PMD_##f,
97 VNET_DPDK_PMD_UNKNOWN, /* must be last */
102 VNET_DPDK_PORT_TYPE_ETH_1G,
103 VNET_DPDK_PORT_TYPE_ETH_2_5G,
104 VNET_DPDK_PORT_TYPE_ETH_5G,
105 VNET_DPDK_PORT_TYPE_ETH_10G,
106 VNET_DPDK_PORT_TYPE_ETH_20G,
107 VNET_DPDK_PORT_TYPE_ETH_25G,
108 VNET_DPDK_PORT_TYPE_ETH_40G,
109 VNET_DPDK_PORT_TYPE_ETH_50G,
110 VNET_DPDK_PORT_TYPE_ETH_56G,
111 VNET_DPDK_PORT_TYPE_ETH_100G,
112 VNET_DPDK_PORT_TYPE_ETH_BOND,
113 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
114 VNET_DPDK_PORT_TYPE_AF_PACKET,
115 VNET_DPDK_PORT_TYPE_ETH_VF,
116 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
117 VNET_DPDK_PORT_TYPE_VHOST_ETHER,
118 VNET_DPDK_PORT_TYPE_FAILSAFE,
119 VNET_DPDK_PORT_TYPE_UNKNOWN,
122 typedef uint16_t dpdk_portid_t;
126 /* Required for vec_validate_aligned */
127 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
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 /* Required for vec_validate_aligned */
146 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
147 struct rte_ring **swq;
148 struct rte_mbuf **pkts_enq;
149 struct rte_mbuf **pkts_deq;
150 struct rte_sched_port *hqos;
156 } dpdk_device_hqos_per_hqos_thread_t;
158 #define foreach_dpdk_device_flags \
159 _( 0, ADMIN_UP, "admin-up") \
160 _( 1, PROMISC, "promisc") \
162 _( 3, PMD_INIT_FAIL, "pmd-init-fail") \
163 _( 4, MAYBE_MULTISEG, "maybe-multiseg") \
164 _( 5, HAVE_SUBIF, "subif") \
165 _( 6, HQOS, "hqos") \
166 _( 7, BOND_SLAVE, "bond-slave") \
167 _( 8, BOND_SLAVE_UP, "bond-slave-up") \
168 _( 9, TX_OFFLOAD, "tx-offload") \
169 _(10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
170 _(11, RX_FLOW_OFFLOAD, "rx-flow-offload")
174 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
175 foreach_dpdk_device_flags
183 struct rte_flow *handle;
191 } dpdk_flow_lookup_entry_t;
195 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
196 volatile u32 **lockp;
198 /* Instance ID to access internal device array. */
199 dpdk_portid_t device_index;
201 /* DPDK device port number */
202 dpdk_portid_t port_id;
207 /* next node index if we decide to steal the rx graph arc */
208 u32 per_interface_next_index;
216 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
218 u8 *interface_name_suffix;
220 /* number of sub-interfaces */
227 u16 *cpu_socket_id_by_queue;
228 u8 *buffer_pool_for_queue;
229 struct rte_eth_conf port_conf;
230 struct rte_eth_txconf tx_conf;
233 u32 supported_flow_actions;
234 dpdk_flow_entry_t *flow_entries; /* pool */
235 dpdk_flow_lookup_entry_t *flow_lookup_entries; /* pool */
236 u32 *parked_lookup_indexes; /* vector */
237 u32 parked_loop_count;
238 struct rte_flow_error last_flow_error;
241 dpdk_device_hqos_per_worker_thread_t *hqos_wt;
242 dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
244 /* af_packet or BondEthernet instance number */
245 u16 af_packet_instance_num;
246 u16 bond_instance_num;
248 /* Bonded interface port# of a slave -
249 only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
250 dpdk_portid_t bond_port;
252 struct rte_eth_link link;
253 f64 time_last_link_update;
255 struct rte_eth_stats stats;
256 struct rte_eth_stats last_stats;
257 struct rte_eth_stats last_cleared_stats;
258 struct rte_eth_xstat *xstats;
259 struct rte_eth_xstat *last_cleared_xstats;
260 f64 time_last_stats_update;
261 dpdk_port_type_t port_type;
264 u8 *default_mac_address;
267 clib_error_t *errors;
270 #define DPDK_STATS_POLL_INTERVAL (10.0)
271 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
273 #define DPDK_LINK_POLL_INTERVAL (3.0)
274 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
280 } dpdk_device_and_queue_t;
282 #ifndef DPDK_HQOS_DBG_BYPASS
283 #define DPDK_HQOS_DBG_BYPASS 0
286 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
287 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
290 typedef struct dpdk_device_config_hqos_t
293 u32 hqos_thread_valid;
299 u32 pktfield0_slabpos;
300 u32 pktfield1_slabpos;
301 u32 pktfield2_slabpos;
302 u64 pktfield0_slabmask;
303 u64 pktfield1_slabmask;
304 u64 pktfield2_slabmask;
307 struct rte_sched_port_params port;
308 struct rte_sched_subport_params *subport;
309 struct rte_sched_pipe_params *pipe;
311 } dpdk_device_config_hqos_t;
313 int dpdk_hqos_validate_mask (u64 mask, u32 n);
314 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
315 hqos, u32 pipe_profile_id);
316 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
317 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
318 dpdk_device_config_hqos_t * hqos);
319 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
320 struct rte_mbuf **pkts, u32 n_pkts);
322 #define foreach_dpdk_device_config_item \
331 vlib_pci_addr_t pci_addr;
333 u8 vlan_strip_offload;
334 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
335 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
336 #define DPDK_DEVICE_VLAN_STRIP_ON 2
338 #define _(x) uword x;
339 foreach_dpdk_device_config_item
341 clib_bitmap_t * workers;
343 dpdk_device_config_hqos_t hqos;
344 } dpdk_device_config_t;
351 u8 *eal_init_args_str;
354 u8 enable_tcp_udp_checksum;
355 u8 no_tx_checksum_offload;
357 /* Required config parameters */
358 u8 coremask_set_manually;
359 u8 nchannels_set_manually;
365 * format interface names ala xxxEthernet%d/%d/%d instead of
366 * xxxEthernet%x/%x/%x.
368 u8 interface_name_format_decimal;
370 /* per-device config */
371 dpdk_device_config_t default_devconf;
372 dpdk_device_config_t *dev_confs;
373 uword *device_config_index_by_pci_addr;
375 } dpdk_config_main_t;
377 extern dpdk_config_main_t dpdk_config_main;
379 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
383 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
384 struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
385 u32 buffers[DPDK_RX_BURST_SZ];
386 u16 next[DPDK_RX_BURST_SZ];
387 u16 etype[DPDK_RX_BURST_SZ];
388 u8 flags[DPDK_RX_BURST_SZ];
389 vlib_buffer_t buffer_template;
390 } dpdk_per_thread_data_t;
395 u32 pcap_sw_if_index;
396 pcap_main_t pcap_main;
403 dpdk_device_t *devices;
404 dpdk_device_and_queue_t **devices_by_hqos_cpu;
405 dpdk_per_thread_data_t *per_thread_data;
407 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
408 u32 buffer_flags_template;
411 dpdk_pcap_t pcap[VLIB_N_RX_TX];
414 pcap_main_t pcap_main;
416 u32 pcap_sw_if_index;
417 u32 pcap_pkts_to_capture;
420 * flag indicating that a posted admin up/down
421 * (via post_sw_interface_set_flags) is in progress
423 u8 admin_up_down_in_progress;
425 /* which cpus are running I/O TX */
426 int hqos_cpu_first_index;
429 /* control interval of dpdk link state and stat polling */
430 f64 link_state_poll_interval;
431 f64 stat_poll_interval;
434 vlib_main_t *vlib_main;
435 vnet_main_t *vnet_main;
436 dpdk_config_main_t *conf;
439 struct rte_mempool **pktmbuf_pools;
441 /* API message ID base */
445 vlib_log_class_t log_default;
448 extern dpdk_main_t dpdk_main;
456 /* Copy of VLIB buffer; packet data stored in pre_data. */
457 vlib_buffer_t buffer;
458 u8 data[256]; /* First 256 data bytes, used for hexdump */
467 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
468 u8 data[256]; /* First 256 data bytes, used for hexdump */
471 void dpdk_device_setup (dpdk_device_t * xd);
472 void dpdk_device_start (dpdk_device_t * xd);
473 void dpdk_device_stop (dpdk_device_t * xd);
475 int dpdk_port_state_callback (dpdk_portid_t port_id,
476 enum rte_eth_event_type type,
477 void *param, void *ret_param);
479 #define foreach_dpdk_error \
480 _(NONE, "no error") \
481 _(RX_PACKET_ERROR, "Rx packet errors") \
482 _(RX_BAD_FCS, "Rx bad fcs") \
483 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
484 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
485 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
486 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
490 #define _(f,s) DPDK_ERROR_##f,
496 #define dpdk_log_err(...) \
497 vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
498 #define dpdk_log_warn(...) \
499 vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
500 #define dpdk_log_notice(...) \
501 vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
502 #define dpdk_log_info(...) \
503 vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
505 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
507 format_function_t format_dpdk_device_name;
508 format_function_t format_dpdk_device;
509 format_function_t format_dpdk_device_errors;
510 format_function_t format_dpdk_tx_trace;
511 format_function_t format_dpdk_rx_trace;
512 format_function_t format_dpdk_rte_mbuf;
513 format_function_t format_dpdk_rx_rte_mbuf;
514 format_function_t format_dpdk_flow;
515 format_function_t format_dpdk_rss_hf_name;
516 format_function_t format_dpdk_rx_offload_caps;
517 format_function_t format_dpdk_tx_offload_caps;
518 unformat_function_t unformat_dpdk_log_level;
519 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
521 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
522 clib_error_t *unformat_hqos (unformat_input_t * input,
523 dpdk_device_config_hqos_t * hqos);
525 clib_error_t *dpdk_pool_create (vlib_main_t * vm, u8 * pool_name,
526 u32 elt_size, u32 num_elts,
527 u32 pool_priv_size, u16 cache_size, u8 numa,
528 struct rte_mempool **_mp,
529 vlib_physmem_region_index_t * pri);
531 clib_error_t *dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
535 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
536 void dpdk_buffer_poison_trajectory_all (void);
539 #endif /* __included_dpdk_h__ */
542 * fd.io coding-style-patch-verification: ON
545 * eval: (c-set-style "gnu")