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_sched.h>
43 #include <rte_bus_pci.h>
46 #include <vnet/devices/devices.h>
49 #define always_inline static inline
51 #define always_inline static inline __attribute__ ((__always_inline__))
54 #include <vlib/pci/pci.h>
55 #include <vnet/flow/flow.h>
57 extern vnet_device_class_t dpdk_device_class;
58 extern vlib_node_registration_t dpdk_input_node;
59 extern vlib_node_registration_t admin_up_down_process_node;
61 #define foreach_dpdk_pmd \
62 _ ("net_thunderx", THUNDERX) \
63 _ ("net_e1000_em", E1000EM) \
64 _ ("net_e1000_igb", IGB) \
65 _ ("net_e1000_igb_vf", IGBVF) \
66 _ ("net_ixgbe", IXGBE) \
67 _ ("net_ixgbe_vf", IXGBEVF) \
68 _ ("net_i40e", I40E) \
69 _ ("net_i40e_vf", I40EVF) \
71 _ ("net_virtio", VIRTIO) \
72 _ ("net_enic", ENIC) \
73 _ ("net_vmxnet3", VMXNET3) \
74 _ ("AF_PACKET PMD", AF_PACKET) \
75 _ ("net_fm10k", FM10K) \
76 _ ("net_cxgbe", CXGBE) \
77 _ ("net_mlx4", MLX4) \
78 _ ("net_mlx5", MLX5) \
79 _ ("net_dpaa2", DPAA2) \
80 _ ("net_virtio_user", VIRTIO_USER) \
81 _ ("net_vhost", VHOST_ETHER) \
83 _ ("net_failsafe", FAILSAFE) \
84 _ ("net_liovf", LIOVF_ETHER) \
85 _ ("net_qede", QEDE) \
86 _ ("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_SWITCH,
111 VNET_DPDK_PORT_TYPE_AF_PACKET,
112 VNET_DPDK_PORT_TYPE_ETH_VF,
113 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
114 VNET_DPDK_PORT_TYPE_VHOST_ETHER,
115 VNET_DPDK_PORT_TYPE_FAILSAFE,
116 VNET_DPDK_PORT_TYPE_NETVSC,
117 VNET_DPDK_PORT_TYPE_UNKNOWN,
120 typedef uint16_t dpdk_portid_t;
124 /* Required for vec_validate_aligned */
125 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
127 struct rte_ring *swq;
129 u64 hqos_field0_slabmask;
130 u32 hqos_field0_slabpos;
131 u32 hqos_field0_slabshr;
132 u64 hqos_field1_slabmask;
133 u32 hqos_field1_slabpos;
134 u32 hqos_field1_slabshr;
135 u64 hqos_field2_slabmask;
136 u32 hqos_field2_slabpos;
137 u32 hqos_field2_slabshr;
138 u32 hqos_tc_table[64];
139 } dpdk_device_hqos_per_worker_thread_t;
143 /* Required for vec_validate_aligned */
144 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
145 struct rte_ring **swq;
146 struct rte_mbuf **pkts_enq;
147 struct rte_mbuf **pkts_deq;
148 struct rte_sched_port *hqos;
154 } dpdk_device_hqos_per_hqos_thread_t;
156 #define foreach_dpdk_device_flags \
157 _( 0, ADMIN_UP, "admin-up") \
158 _( 1, PROMISC, "promisc") \
160 _( 3, PMD_INIT_FAIL, "pmd-init-fail") \
161 _( 4, MAYBE_MULTISEG, "maybe-multiseg") \
162 _( 5, HAVE_SUBIF, "subif") \
163 _( 6, HQOS, "hqos") \
164 _( 9, TX_OFFLOAD, "tx-offload") \
165 _(10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
166 _(11, RX_FLOW_OFFLOAD, "rx-flow-offload") \
167 _(12, RX_IP4_CKSUM, "rx-ip4-cksum")
171 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
172 foreach_dpdk_device_flags
180 struct rte_flow *handle;
188 } dpdk_flow_lookup_entry_t;
192 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
193 volatile u32 **lockp;
195 /* Instance ID to access internal device array. */
196 dpdk_portid_t device_index;
198 /* DPDK device port number */
199 dpdk_portid_t port_id;
204 /* next node index if we decide to steal the rx graph arc */
205 u32 per_interface_next_index;
213 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
216 u8 *interface_name_suffix;
218 /* number of sub-interfaces */
225 u16 *cpu_socket_id_by_queue;
226 u8 *buffer_pool_for_queue;
227 struct rte_eth_conf port_conf;
228 struct rte_eth_txconf tx_conf;
231 u32 supported_flow_actions;
232 dpdk_flow_entry_t *flow_entries; /* pool */
233 dpdk_flow_lookup_entry_t *flow_lookup_entries; /* pool */
234 u32 *parked_lookup_indexes; /* vector */
235 u32 parked_loop_count;
236 struct rte_flow_error last_flow_error;
239 dpdk_device_hqos_per_worker_thread_t *hqos_wt;
240 dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
242 /* af_packet instance number */
243 u16 af_packet_instance_num;
245 struct rte_eth_link link;
246 f64 time_last_link_update;
248 struct rte_eth_stats stats;
249 struct rte_eth_stats last_stats;
250 struct rte_eth_xstat *xstats;
251 f64 time_last_stats_update;
252 dpdk_port_type_t port_type;
255 u8 *default_mac_address;
258 clib_error_t *errors;
261 #define DPDK_STATS_POLL_INTERVAL (10.0)
262 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
264 #define DPDK_LINK_POLL_INTERVAL (3.0)
265 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
271 } dpdk_device_and_queue_t;
273 #ifndef DPDK_HQOS_DBG_BYPASS
274 #define DPDK_HQOS_DBG_BYPASS 0
277 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
278 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
281 typedef struct dpdk_device_config_hqos_t
284 u32 hqos_thread_valid;
290 u32 pktfield0_slabpos;
291 u32 pktfield1_slabpos;
292 u32 pktfield2_slabpos;
293 u64 pktfield0_slabmask;
294 u64 pktfield1_slabmask;
295 u64 pktfield2_slabmask;
298 struct rte_sched_port_params port;
299 struct rte_sched_subport_params *subport;
300 struct rte_sched_pipe_params *pipe;
302 } dpdk_device_config_hqos_t;
304 int dpdk_hqos_validate_mask (u64 mask, u32 n);
305 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
306 hqos, u32 pipe_profile_id);
308 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
310 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
311 dpdk_device_config_hqos_t * hqos);
312 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
313 struct rte_mbuf **pkts, u32 n_pkts);
315 #define foreach_dpdk_device_config_item \
324 vlib_pci_addr_t pci_addr;
327 u8 vlan_strip_offload;
328 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
329 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
330 #define DPDK_DEVICE_VLAN_STRIP_ON 2
332 #define _(x) uword x;
333 foreach_dpdk_device_config_item
335 clib_bitmap_t * workers;
337 dpdk_device_config_hqos_t hqos;
341 #define DPDK_DEVICE_TSO_DEFAULT 0
342 #define DPDK_DEVICE_TSO_OFF 1
343 #define DPDK_DEVICE_TSO_ON 2
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;
362 u32 num_crypto_mbufs;
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 /* devices blacklist by pci vendor_id, device_id */
376 u32 *blacklist_by_pci_vendor_and_device;
378 } dpdk_config_main_t;
380 extern dpdk_config_main_t dpdk_config_main;
382 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
386 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
387 struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
388 u32 buffers[DPDK_RX_BURST_SZ];
389 u16 next[DPDK_RX_BURST_SZ];
390 u16 etype[DPDK_RX_BURST_SZ];
391 u16 flags[DPDK_RX_BURST_SZ];
392 vlib_buffer_t buffer_template;
393 } dpdk_per_thread_data_t;
399 dpdk_device_t *devices;
400 dpdk_device_and_queue_t **devices_by_hqos_cpu;
401 dpdk_per_thread_data_t *per_thread_data;
403 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
404 u32 buffer_flags_template;
407 * flag indicating that a posted admin up/down
408 * (via post_sw_interface_set_flags) is in progress
410 u8 admin_up_down_in_progress;
412 /* which cpus are running I/O TX */
413 int hqos_cpu_first_index;
416 /* control interval of dpdk link state and stat polling */
417 f64 link_state_poll_interval;
418 f64 stat_poll_interval;
421 vlib_main_t *vlib_main;
422 vnet_main_t *vnet_main;
423 dpdk_config_main_t *conf;
425 /* API message ID base */
429 vlib_log_class_t log_default;
432 extern dpdk_main_t dpdk_main;
440 /* Copy of VLIB buffer; packet data stored in pre_data. */
441 vlib_buffer_t buffer;
442 u8 data[256]; /* First 256 data bytes, used for hexdump */
451 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
452 u8 data[256]; /* First 256 data bytes, used for hexdump */
455 void dpdk_device_setup (dpdk_device_t * xd);
456 void dpdk_device_start (dpdk_device_t * xd);
457 void dpdk_device_stop (dpdk_device_t * xd);
459 int dpdk_port_state_callback (dpdk_portid_t port_id,
460 enum rte_eth_event_type type,
461 void *param, void *ret_param);
463 #define foreach_dpdk_error \
464 _(NONE, "no error") \
465 _(RX_PACKET_ERROR, "Rx packet errors") \
466 _(RX_BAD_FCS, "Rx bad fcs") \
467 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
468 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
469 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
470 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
474 #define _(f,s) DPDK_ERROR_##f,
480 #define dpdk_log_err(...) \
481 vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
482 #define dpdk_log_warn(...) \
483 vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
484 #define dpdk_log_notice(...) \
485 vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
486 #define dpdk_log_info(...) \
487 vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
489 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
491 format_function_t format_dpdk_device_name;
492 format_function_t format_dpdk_device;
493 format_function_t format_dpdk_device_errors;
494 format_function_t format_dpdk_tx_trace;
495 format_function_t format_dpdk_rx_trace;
496 format_function_t format_dpdk_rte_mbuf;
497 format_function_t format_dpdk_rx_rte_mbuf;
498 format_function_t format_dpdk_flow;
499 format_function_t format_dpdk_rss_hf_name;
500 format_function_t format_dpdk_rx_offload_caps;
501 format_function_t format_dpdk_tx_offload_caps;
502 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
504 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
505 clib_error_t *unformat_hqos (unformat_input_t * input,
506 dpdk_device_config_hqos_t * hqos);
508 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
510 void dpdk_cli_reference (void);
513 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
514 void dpdk_buffer_poison_trajectory_all (void);
517 #endif /* __included_dpdk_h__ */
520 * fd.io coding-style-patch-verification: ON
523 * eval: (c-set-style "gnu")