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/devices/devices.h>
50 #define always_inline static inline
52 #define always_inline static inline __attribute__ ((__always_inline__))
55 #include <vlib/pci/pci.h>
56 #include <vnet/flow/flow.h>
58 extern vnet_device_class_t dpdk_device_class;
59 extern vlib_node_registration_t dpdk_input_node;
60 extern vlib_node_registration_t admin_up_down_process_node;
62 #define foreach_dpdk_pmd \
63 _ ("net_thunderx", THUNDERX) \
64 _ ("net_e1000_em", E1000EM) \
65 _ ("net_e1000_igb", IGB) \
66 _ ("net_e1000_igb_vf", IGBVF) \
67 _ ("net_ixgbe", IXGBE) \
68 _ ("net_ixgbe_vf", IXGBEVF) \
69 _ ("net_i40e", I40E) \
70 _ ("net_i40e_vf", I40EVF) \
71 _ ("net_virtio", VIRTIO) \
72 _ ("net_enic", ENIC) \
73 _ ("net_vmxnet3", VMXNET3) \
74 _ ("AF_PACKET PMD", AF_PACKET) \
75 _ ("net_bonding", BOND) \
76 _ ("net_fm10k", FM10K) \
77 _ ("net_cxgbe", CXGBE) \
78 _ ("net_mlx4", MLX4) \
79 _ ("net_mlx5", MLX5) \
80 _ ("net_dpaa2", DPAA2) \
81 _ ("net_virtio_user", VIRTIO_USER) \
82 _ ("net_vhost", VHOST_ETHER) \
84 _ ("net_failsafe", FAILSAFE) \
85 _ ("net_liovf", LIOVF_ETHER) \
86 _ ("net_qede", QEDE) \
87 _ ("net_netvsc", NETVSC)
92 #define _(s,f) VNET_DPDK_PMD_##f,
95 VNET_DPDK_PMD_UNKNOWN, /* must be last */
100 VNET_DPDK_PORT_TYPE_ETH_1G,
101 VNET_DPDK_PORT_TYPE_ETH_2_5G,
102 VNET_DPDK_PORT_TYPE_ETH_5G,
103 VNET_DPDK_PORT_TYPE_ETH_10G,
104 VNET_DPDK_PORT_TYPE_ETH_20G,
105 VNET_DPDK_PORT_TYPE_ETH_25G,
106 VNET_DPDK_PORT_TYPE_ETH_40G,
107 VNET_DPDK_PORT_TYPE_ETH_50G,
108 VNET_DPDK_PORT_TYPE_ETH_56G,
109 VNET_DPDK_PORT_TYPE_ETH_100G,
110 VNET_DPDK_PORT_TYPE_ETH_BOND,
111 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
112 VNET_DPDK_PORT_TYPE_AF_PACKET,
113 VNET_DPDK_PORT_TYPE_ETH_VF,
114 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
115 VNET_DPDK_PORT_TYPE_VHOST_ETHER,
116 VNET_DPDK_PORT_TYPE_FAILSAFE,
117 VNET_DPDK_PORT_TYPE_NETVSC,
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") \
170 _(12, RX_IP4_CKSUM, "rx-ip4-cksum")
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);
219 u8 *interface_name_suffix;
221 /* number of sub-interfaces */
228 u16 *cpu_socket_id_by_queue;
229 u8 *buffer_pool_for_queue;
230 struct rte_eth_conf port_conf;
231 struct rte_eth_txconf tx_conf;
234 u32 supported_flow_actions;
235 dpdk_flow_entry_t *flow_entries; /* pool */
236 dpdk_flow_lookup_entry_t *flow_lookup_entries; /* pool */
237 u32 *parked_lookup_indexes; /* vector */
238 u32 parked_loop_count;
239 struct rte_flow_error last_flow_error;
242 dpdk_device_hqos_per_worker_thread_t *hqos_wt;
243 dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
245 /* af_packet or BondEthernet instance number */
246 u16 af_packet_instance_num;
247 u16 bond_instance_num;
249 /* Bonded interface port# of a slave -
250 only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
251 dpdk_portid_t bond_port;
253 struct rte_eth_link link;
254 f64 time_last_link_update;
256 struct rte_eth_stats stats;
257 struct rte_eth_stats last_stats;
258 struct rte_eth_stats last_cleared_stats;
259 struct rte_eth_xstat *xstats;
260 struct rte_eth_xstat *last_cleared_xstats;
261 f64 time_last_stats_update;
262 dpdk_port_type_t port_type;
265 u8 *default_mac_address;
268 clib_error_t *errors;
271 #define DPDK_STATS_POLL_INTERVAL (10.0)
272 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
274 #define DPDK_LINK_POLL_INTERVAL (3.0)
275 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
281 } dpdk_device_and_queue_t;
283 #ifndef DPDK_HQOS_DBG_BYPASS
284 #define DPDK_HQOS_DBG_BYPASS 0
287 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
288 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
291 typedef struct dpdk_device_config_hqos_t
294 u32 hqos_thread_valid;
300 u32 pktfield0_slabpos;
301 u32 pktfield1_slabpos;
302 u32 pktfield2_slabpos;
303 u64 pktfield0_slabmask;
304 u64 pktfield1_slabmask;
305 u64 pktfield2_slabmask;
308 struct rte_sched_port_params port;
309 struct rte_sched_subport_params *subport;
310 struct rte_sched_pipe_params *pipe;
312 } dpdk_device_config_hqos_t;
314 int dpdk_hqos_validate_mask (u64 mask, u32 n);
315 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
316 hqos, u32 pipe_profile_id);
318 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
320 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
321 dpdk_device_config_hqos_t * hqos);
322 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
323 struct rte_mbuf **pkts, u32 n_pkts);
325 #define foreach_dpdk_device_config_item \
334 vlib_pci_addr_t pci_addr;
337 u8 vlan_strip_offload;
338 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
339 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
340 #define DPDK_DEVICE_VLAN_STRIP_ON 2
342 #define _(x) uword x;
343 foreach_dpdk_device_config_item
345 clib_bitmap_t * workers;
347 dpdk_device_config_hqos_t hqos;
348 } dpdk_device_config_t;
355 u8 *eal_init_args_str;
358 u8 enable_tcp_udp_checksum;
359 u8 no_tx_checksum_offload;
361 /* Required config parameters */
362 u8 coremask_set_manually;
363 u8 nchannels_set_manually;
366 u32 num_crypto_mbufs;
369 * format interface names ala xxxEthernet%d/%d/%d instead of
370 * xxxEthernet%x/%x/%x.
372 u8 interface_name_format_decimal;
374 /* per-device config */
375 dpdk_device_config_t default_devconf;
376 dpdk_device_config_t *dev_confs;
377 uword *device_config_index_by_pci_addr;
379 /* devices blacklist by pci vendor_id, device_id */
380 u32 *blacklist_by_pci_vendor_and_device;
382 } dpdk_config_main_t;
384 extern dpdk_config_main_t dpdk_config_main;
386 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
390 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
391 struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
392 u32 buffers[DPDK_RX_BURST_SZ];
393 u16 next[DPDK_RX_BURST_SZ];
394 u16 etype[DPDK_RX_BURST_SZ];
395 u8 flags[DPDK_RX_BURST_SZ];
396 vlib_buffer_t buffer_template;
397 } dpdk_per_thread_data_t;
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 * flag indicating that a posted admin up/down
412 * (via post_sw_interface_set_flags) is in progress
414 u8 admin_up_down_in_progress;
416 /* which cpus are running I/O TX */
417 int hqos_cpu_first_index;
420 /* control interval of dpdk link state and stat polling */
421 f64 link_state_poll_interval;
422 f64 stat_poll_interval;
425 vlib_main_t *vlib_main;
426 vnet_main_t *vnet_main;
427 dpdk_config_main_t *conf;
429 /* API message ID base */
433 vlib_log_class_t log_default;
436 extern dpdk_main_t dpdk_main;
444 /* Copy of VLIB buffer; packet data stored in pre_data. */
445 vlib_buffer_t buffer;
446 u8 data[256]; /* First 256 data bytes, used for hexdump */
455 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
456 u8 data[256]; /* First 256 data bytes, used for hexdump */
459 void dpdk_device_setup (dpdk_device_t * xd);
460 void dpdk_device_start (dpdk_device_t * xd);
461 void dpdk_device_stop (dpdk_device_t * xd);
463 int dpdk_port_state_callback (dpdk_portid_t port_id,
464 enum rte_eth_event_type type,
465 void *param, void *ret_param);
467 #define foreach_dpdk_error \
468 _(NONE, "no error") \
469 _(RX_PACKET_ERROR, "Rx packet errors") \
470 _(RX_BAD_FCS, "Rx bad fcs") \
471 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
472 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
473 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
474 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
478 #define _(f,s) DPDK_ERROR_##f,
484 #define dpdk_log_err(...) \
485 vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
486 #define dpdk_log_warn(...) \
487 vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
488 #define dpdk_log_notice(...) \
489 vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
490 #define dpdk_log_info(...) \
491 vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
493 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
495 format_function_t format_dpdk_device_name;
496 format_function_t format_dpdk_device;
497 format_function_t format_dpdk_device_errors;
498 format_function_t format_dpdk_tx_trace;
499 format_function_t format_dpdk_rx_trace;
500 format_function_t format_dpdk_rte_mbuf;
501 format_function_t format_dpdk_rx_rte_mbuf;
502 format_function_t format_dpdk_flow;
503 format_function_t format_dpdk_rss_hf_name;
504 format_function_t format_dpdk_rx_offload_caps;
505 format_function_t format_dpdk_tx_offload_caps;
506 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
508 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
509 clib_error_t *unformat_hqos (unformat_input_t * input,
510 dpdk_device_config_hqos_t * hqos);
512 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
516 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
517 void dpdk_buffer_poison_trajectory_all (void);
520 #endif /* __included_dpdk_h__ */
523 * fd.io coding-style-patch-verification: ON
526 * eval: (c-set-style "gnu")