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) \
89 _ ("net_qede", QEDE) \
90 _ ("net_netvsc", NETVSC)
95 #define _(s,f) VNET_DPDK_PMD_##f,
98 VNET_DPDK_PMD_UNKNOWN, /* must be last */
103 VNET_DPDK_PORT_TYPE_ETH_1G,
104 VNET_DPDK_PORT_TYPE_ETH_2_5G,
105 VNET_DPDK_PORT_TYPE_ETH_5G,
106 VNET_DPDK_PORT_TYPE_ETH_10G,
107 VNET_DPDK_PORT_TYPE_ETH_20G,
108 VNET_DPDK_PORT_TYPE_ETH_25G,
109 VNET_DPDK_PORT_TYPE_ETH_40G,
110 VNET_DPDK_PORT_TYPE_ETH_50G,
111 VNET_DPDK_PORT_TYPE_ETH_56G,
112 VNET_DPDK_PORT_TYPE_ETH_100G,
113 VNET_DPDK_PORT_TYPE_ETH_BOND,
114 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
115 VNET_DPDK_PORT_TYPE_AF_PACKET,
116 VNET_DPDK_PORT_TYPE_ETH_VF,
117 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
118 VNET_DPDK_PORT_TYPE_VHOST_ETHER,
119 VNET_DPDK_PORT_TYPE_FAILSAFE,
120 VNET_DPDK_PORT_TYPE_NETVSC,
121 VNET_DPDK_PORT_TYPE_UNKNOWN,
124 typedef uint16_t dpdk_portid_t;
128 /* Required for vec_validate_aligned */
129 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
131 struct rte_ring *swq;
133 u64 hqos_field0_slabmask;
134 u32 hqos_field0_slabpos;
135 u32 hqos_field0_slabshr;
136 u64 hqos_field1_slabmask;
137 u32 hqos_field1_slabpos;
138 u32 hqos_field1_slabshr;
139 u64 hqos_field2_slabmask;
140 u32 hqos_field2_slabpos;
141 u32 hqos_field2_slabshr;
142 u32 hqos_tc_table[64];
143 } dpdk_device_hqos_per_worker_thread_t;
147 /* Required for vec_validate_aligned */
148 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
149 struct rte_ring **swq;
150 struct rte_mbuf **pkts_enq;
151 struct rte_mbuf **pkts_deq;
152 struct rte_sched_port *hqos;
158 } dpdk_device_hqos_per_hqos_thread_t;
160 #define foreach_dpdk_device_flags \
161 _( 0, ADMIN_UP, "admin-up") \
162 _( 1, PROMISC, "promisc") \
164 _( 3, PMD_INIT_FAIL, "pmd-init-fail") \
165 _( 4, MAYBE_MULTISEG, "maybe-multiseg") \
166 _( 5, HAVE_SUBIF, "subif") \
167 _( 6, HQOS, "hqos") \
168 _( 7, BOND_SLAVE, "bond-slave") \
169 _( 8, BOND_SLAVE_UP, "bond-slave-up") \
170 _( 9, TX_OFFLOAD, "tx-offload") \
171 _(10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
172 _(11, RX_FLOW_OFFLOAD, "rx-flow-offload")
176 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
177 foreach_dpdk_device_flags
185 struct rte_flow *handle;
193 } dpdk_flow_lookup_entry_t;
197 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
198 volatile u32 **lockp;
200 /* Instance ID to access internal device array. */
201 dpdk_portid_t device_index;
203 /* DPDK device port number */
204 dpdk_portid_t port_id;
209 /* next node index if we decide to steal the rx graph arc */
210 u32 per_interface_next_index;
218 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
220 u8 *interface_name_suffix;
222 /* number of sub-interfaces */
229 u16 *cpu_socket_id_by_queue;
230 u8 *buffer_pool_for_queue;
231 struct rte_eth_conf port_conf;
232 struct rte_eth_txconf tx_conf;
235 u32 supported_flow_actions;
236 dpdk_flow_entry_t *flow_entries; /* pool */
237 dpdk_flow_lookup_entry_t *flow_lookup_entries; /* pool */
238 u32 *parked_lookup_indexes; /* vector */
239 u32 parked_loop_count;
240 struct rte_flow_error last_flow_error;
243 dpdk_device_hqos_per_worker_thread_t *hqos_wt;
244 dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
246 /* af_packet or BondEthernet instance number */
247 u16 af_packet_instance_num;
248 u16 bond_instance_num;
250 /* Bonded interface port# of a slave -
251 only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
252 dpdk_portid_t bond_port;
254 struct rte_eth_link link;
255 f64 time_last_link_update;
257 struct rte_eth_stats stats;
258 struct rte_eth_stats last_stats;
259 struct rte_eth_stats last_cleared_stats;
260 struct rte_eth_xstat *xstats;
261 struct rte_eth_xstat *last_cleared_xstats;
262 f64 time_last_stats_update;
263 dpdk_port_type_t port_type;
266 u8 *default_mac_address;
269 clib_error_t *errors;
272 #define DPDK_STATS_POLL_INTERVAL (10.0)
273 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
275 #define DPDK_LINK_POLL_INTERVAL (3.0)
276 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
282 } dpdk_device_and_queue_t;
284 #ifndef DPDK_HQOS_DBG_BYPASS
285 #define DPDK_HQOS_DBG_BYPASS 0
288 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
289 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
292 typedef struct dpdk_device_config_hqos_t
295 u32 hqos_thread_valid;
301 u32 pktfield0_slabpos;
302 u32 pktfield1_slabpos;
303 u32 pktfield2_slabpos;
304 u64 pktfield0_slabmask;
305 u64 pktfield1_slabmask;
306 u64 pktfield2_slabmask;
309 struct rte_sched_port_params port;
310 struct rte_sched_subport_params *subport;
311 struct rte_sched_pipe_params *pipe;
313 } dpdk_device_config_hqos_t;
315 int dpdk_hqos_validate_mask (u64 mask, u32 n);
316 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
317 hqos, u32 pipe_profile_id);
318 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
319 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
320 dpdk_device_config_hqos_t * hqos);
321 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
322 struct rte_mbuf **pkts, u32 n_pkts);
324 #define foreach_dpdk_device_config_item \
333 vlib_pci_addr_t pci_addr;
335 u8 vlan_strip_offload;
336 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
337 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
338 #define DPDK_DEVICE_VLAN_STRIP_ON 2
340 #define _(x) uword x;
341 foreach_dpdk_device_config_item
343 clib_bitmap_t * workers;
345 dpdk_device_config_hqos_t hqos;
346 } dpdk_device_config_t;
353 u8 *eal_init_args_str;
356 u8 enable_tcp_udp_checksum;
357 u8 no_tx_checksum_offload;
359 /* Required config parameters */
360 u8 coremask_set_manually;
361 u8 nchannels_set_manually;
367 * format interface names ala xxxEthernet%d/%d/%d instead of
368 * xxxEthernet%x/%x/%x.
370 u8 interface_name_format_decimal;
372 /* per-device config */
373 dpdk_device_config_t default_devconf;
374 dpdk_device_config_t *dev_confs;
375 uword *device_config_index_by_pci_addr;
377 } dpdk_config_main_t;
379 extern dpdk_config_main_t dpdk_config_main;
381 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
385 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
386 struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
387 u32 buffers[DPDK_RX_BURST_SZ];
388 u16 next[DPDK_RX_BURST_SZ];
389 u16 etype[DPDK_RX_BURST_SZ];
390 u8 flags[DPDK_RX_BURST_SZ];
391 vlib_buffer_t buffer_template;
392 } dpdk_per_thread_data_t;
397 u32 pcap_sw_if_index;
398 pcap_main_t pcap_main;
405 dpdk_device_t *devices;
406 dpdk_device_and_queue_t **devices_by_hqos_cpu;
407 dpdk_per_thread_data_t *per_thread_data;
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 format_function_t format_dpdk_rss_hf_name;
518 format_function_t format_dpdk_rx_offload_caps;
519 format_function_t format_dpdk_tx_offload_caps;
520 unformat_function_t unformat_dpdk_log_level;
521 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
523 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
524 clib_error_t *unformat_hqos (unformat_input_t * input,
525 dpdk_device_config_hqos_t * hqos);
527 clib_error_t *dpdk_pool_create (vlib_main_t * vm, u8 * pool_name,
528 u32 elt_size, u32 num_elts,
529 u32 pool_priv_size, u16 cache_size, u8 numa,
530 struct rte_mempool **_mp, u32 * map_index);
532 clib_error_t *dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
535 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
539 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
540 void dpdk_buffer_poison_trajectory_all (void);
543 #endif /* __included_dpdk_h__ */
546 * fd.io coding-style-patch-verification: ON
549 * eval: (c-set-style "gnu")