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;
64 #define foreach_dpdk_pmd \
65 _ ("net_thunderx", THUNDERX) \
66 _ ("net_e1000_em", E1000EM) \
67 _ ("net_e1000_igb", IGB) \
68 _ ("net_e1000_igb_vf", IGBVF) \
69 _ ("net_ixgbe", IXGBE) \
70 _ ("net_ixgbe_vf", IXGBEVF) \
71 _ ("net_i40e", I40E) \
72 _ ("net_i40e_vf", I40EVF) \
73 _ ("net_virtio", VIRTIO) \
74 _ ("net_enic", ENIC) \
75 _ ("net_vmxnet3", VMXNET3) \
76 _ ("AF_PACKET PMD", AF_PACKET) \
77 _ ("net_bonding", BOND) \
78 _ ("net_fm10k", FM10K) \
79 _ ("net_cxgbe", CXGBE) \
80 _ ("net_mlx4", MLX4) \
81 _ ("net_mlx5", MLX5) \
82 _ ("net_dpaa2", DPAA2) \
83 _ ("net_virtio_user", VIRTIO_USER) \
84 _ ("net_vhost", VHOST_ETHER) \
86 _ ("net_failsafe", FAILSAFE) \
87 _ ("net_liovf", LIOVF_ETHER) \
93 #define _(s,f) VNET_DPDK_PMD_##f,
96 VNET_DPDK_PMD_UNKNOWN, /* must be last */
101 VNET_DPDK_PORT_TYPE_ETH_1G,
102 VNET_DPDK_PORT_TYPE_ETH_2_5G,
103 VNET_DPDK_PORT_TYPE_ETH_5G,
104 VNET_DPDK_PORT_TYPE_ETH_10G,
105 VNET_DPDK_PORT_TYPE_ETH_20G,
106 VNET_DPDK_PORT_TYPE_ETH_25G,
107 VNET_DPDK_PORT_TYPE_ETH_40G,
108 VNET_DPDK_PORT_TYPE_ETH_50G,
109 VNET_DPDK_PORT_TYPE_ETH_56G,
110 VNET_DPDK_PORT_TYPE_ETH_100G,
111 VNET_DPDK_PORT_TYPE_ETH_BOND,
112 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
113 VNET_DPDK_PORT_TYPE_AF_PACKET,
114 VNET_DPDK_PORT_TYPE_ETH_VF,
115 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
116 VNET_DPDK_PORT_TYPE_VHOST_ETHER,
117 VNET_DPDK_PORT_TYPE_FAILSAFE,
118 VNET_DPDK_PORT_TYPE_UNKNOWN,
121 typedef uint16_t dpdk_portid_t;
125 /* Required for vec_validate_aligned */
126 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
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 /* Required for vec_validate_aligned */
145 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
146 struct rte_ring **swq;
147 struct rte_mbuf **pkts_enq;
148 struct rte_mbuf **pkts_deq;
149 struct rte_sched_port *hqos;
155 } dpdk_device_hqos_per_hqos_thread_t;
157 #define foreach_dpdk_device_flags \
158 _( 0, ADMIN_UP, "admin-up") \
159 _( 1, PROMISC, "promisc") \
161 _( 3, PMD_INIT_FAIL, "pmd-init-fail") \
162 _( 4, MAYBE_MULTISEG, "maybe-multiseg") \
163 _( 5, HAVE_SUBIF, "subif") \
164 _( 6, HQOS, "hqos") \
165 _( 7, BOND_SLAVE, "bond-slave") \
166 _( 8, BOND_SLAVE_UP, "bond-slave-up") \
167 _( 9, TX_OFFLOAD, "tx-offload") \
168 _(10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
169 _(11, RX_FLOW_OFFLOAD, "rx-flow-offload")
173 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
174 foreach_dpdk_device_flags
182 struct rte_flow *handle;
190 } dpdk_flow_lookup_entry_t;
194 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
195 volatile u32 **lockp;
197 /* Instance ID to access internal device array. */
198 dpdk_portid_t device_index;
200 /* DPDK device port number */
201 dpdk_portid_t port_id;
206 /* next node index if we decide to steal the rx graph arc */
207 u32 per_interface_next_index;
215 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
217 u8 *interface_name_suffix;
219 /* number of sub-interfaces */
226 u16 *cpu_socket_id_by_queue;
227 u8 *buffer_pool_for_queue;
228 struct rte_eth_conf port_conf;
229 struct rte_eth_txconf tx_conf;
232 u32 supported_flow_actions;
233 dpdk_flow_entry_t *flow_entries; /* pool */
234 dpdk_flow_lookup_entry_t *flow_lookup_entries; /* pool */
235 u32 *parked_lookup_indexes; /* vector */
236 u32 parked_loop_count;
237 struct rte_flow_error last_flow_error;
240 dpdk_device_hqos_per_worker_thread_t *hqos_wt;
241 dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
243 /* af_packet or BondEthernet instance number */
244 u16 af_packet_instance_num;
245 u16 bond_instance_num;
247 /* Bonded interface port# of a slave -
248 only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
249 dpdk_portid_t bond_port;
251 struct rte_eth_link link;
252 f64 time_last_link_update;
254 struct rte_eth_stats stats;
255 struct rte_eth_stats last_stats;
256 struct rte_eth_stats last_cleared_stats;
257 struct rte_eth_xstat *xstats;
258 struct rte_eth_xstat *last_cleared_xstats;
259 f64 time_last_stats_update;
260 dpdk_port_type_t port_type;
263 u8 *default_mac_address;
266 clib_error_t *errors;
269 #define DPDK_STATS_POLL_INTERVAL (10.0)
270 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
272 #define DPDK_LINK_POLL_INTERVAL (3.0)
273 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
279 } dpdk_device_and_queue_t;
281 #ifndef DPDK_HQOS_DBG_BYPASS
282 #define DPDK_HQOS_DBG_BYPASS 0
285 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
286 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
289 typedef struct dpdk_device_config_hqos_t
292 u32 hqos_thread_valid;
298 u32 pktfield0_slabpos;
299 u32 pktfield1_slabpos;
300 u32 pktfield2_slabpos;
301 u64 pktfield0_slabmask;
302 u64 pktfield1_slabmask;
303 u64 pktfield2_slabmask;
306 struct rte_sched_port_params port;
307 struct rte_sched_subport_params *subport;
308 struct rte_sched_pipe_params *pipe;
310 } dpdk_device_config_hqos_t;
312 int dpdk_hqos_validate_mask (u64 mask, u32 n);
313 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
314 hqos, u32 pipe_profile_id);
315 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
316 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
317 dpdk_device_config_hqos_t * hqos);
318 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
319 struct rte_mbuf **pkts, u32 n_pkts);
321 #define foreach_dpdk_device_config_item \
330 vlib_pci_addr_t pci_addr;
332 u8 vlan_strip_offload;
333 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
334 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
335 #define DPDK_DEVICE_VLAN_STRIP_ON 2
337 #define _(x) uword x;
338 foreach_dpdk_device_config_item
340 clib_bitmap_t * workers;
342 dpdk_device_config_hqos_t hqos;
343 } dpdk_device_config_t;
350 u8 *eal_init_args_str;
353 u8 enable_tcp_udp_checksum;
354 u8 no_tx_checksum_offload;
356 /* Required config parameters */
357 u8 coremask_set_manually;
358 u8 nchannels_set_manually;
364 * format interface names ala xxxEthernet%d/%d/%d instead of
365 * xxxEthernet%x/%x/%x.
367 u8 interface_name_format_decimal;
369 /* per-device config */
370 dpdk_device_config_t default_devconf;
371 dpdk_device_config_t *dev_confs;
372 uword *device_config_index_by_pci_addr;
374 } dpdk_config_main_t;
376 extern dpdk_config_main_t dpdk_config_main;
378 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
382 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
383 struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
384 u32 buffers[DPDK_RX_BURST_SZ];
385 u16 next[DPDK_RX_BURST_SZ];
386 u16 etype[DPDK_RX_BURST_SZ];
387 u8 flags[DPDK_RX_BURST_SZ];
388 vlib_buffer_t buffer_template;
389 } dpdk_per_thread_data_t;
394 u32 pcap_sw_if_index;
395 pcap_main_t pcap_main;
402 dpdk_device_t *devices;
403 dpdk_device_and_queue_t **devices_by_hqos_cpu;
404 dpdk_per_thread_data_t *per_thread_data;
406 /* per-thread recycle lists */
409 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
410 u32 buffer_flags_template;
413 dpdk_pcap_t pcap[VLIB_N_RX_TX];
416 pcap_main_t pcap_main;
418 u32 pcap_sw_if_index;
419 u32 pcap_pkts_to_capture;
422 * flag indicating that a posted admin up/down
423 * (via post_sw_interface_set_flags) is in progress
425 u8 admin_up_down_in_progress;
427 /* which cpus are running I/O TX */
428 int hqos_cpu_first_index;
431 /* control interval of dpdk link state and stat polling */
432 f64 link_state_poll_interval;
433 f64 stat_poll_interval;
436 vlib_main_t *vlib_main;
437 vnet_main_t *vnet_main;
438 dpdk_config_main_t *conf;
441 struct rte_mempool **pktmbuf_pools;
443 /* API message ID base */
447 vlib_log_class_t log_default;
450 extern dpdk_main_t dpdk_main;
458 /* Copy of VLIB buffer; packet data stored in pre_data. */
459 vlib_buffer_t buffer;
460 u8 data[256]; /* First 256 data bytes, used for hexdump */
469 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
470 u8 data[256]; /* First 256 data bytes, used for hexdump */
473 void dpdk_device_setup (dpdk_device_t * xd);
474 void dpdk_device_start (dpdk_device_t * xd);
475 void dpdk_device_stop (dpdk_device_t * xd);
477 int dpdk_port_state_callback (dpdk_portid_t port_id,
478 enum rte_eth_event_type type,
479 void *param, void *ret_param);
481 #define foreach_dpdk_error \
482 _(NONE, "no error") \
483 _(RX_PACKET_ERROR, "Rx packet errors") \
484 _(RX_BAD_FCS, "Rx bad fcs") \
485 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
486 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
487 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
488 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
492 #define _(f,s) DPDK_ERROR_##f,
498 #define dpdk_log_err(...) \
499 vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
500 #define dpdk_log_warn(...) \
501 vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
502 #define dpdk_log_notice(...) \
503 vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
504 #define dpdk_log_info(...) \
505 vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
507 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
509 format_function_t format_dpdk_device_name;
510 format_function_t format_dpdk_device;
511 format_function_t format_dpdk_device_errors;
512 format_function_t format_dpdk_tx_trace;
513 format_function_t format_dpdk_rx_trace;
514 format_function_t format_dpdk_rte_mbuf;
515 format_function_t format_dpdk_rx_rte_mbuf;
516 format_function_t format_dpdk_flow;
517 unformat_function_t unformat_dpdk_log_level;
518 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
520 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
521 clib_error_t *unformat_hqos (unformat_input_t * input,
522 dpdk_device_config_hqos_t * hqos);
525 admin_up_down_process (vlib_main_t * vm,
526 vlib_node_runtime_t * rt, vlib_frame_t * f);
528 clib_error_t *dpdk_pool_create (vlib_main_t * vm, u8 * pool_name,
529 u32 elt_size, u32 num_elts,
530 u32 pool_priv_size, u16 cache_size, u8 numa,
531 struct rte_mempool **_mp,
532 vlib_physmem_region_index_t * pri);
534 clib_error_t *dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
538 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
539 void dpdk_buffer_poison_trajectory_all (void);
542 #endif /* __included_dpdk_h__ */
545 * fd.io coding-style-patch-verification: ON
548 * eval: (c-set-style "gnu")