FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
dpdk.h
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 #ifndef __included_dpdk_h__
16 #define __included_dpdk_h__
17 
18 /* $$$$ We should rename always_inline -> clib_always_inline */
19 #undef always_inline
20 
21 #define ALLOW_EXPERIMENTAL_API
22 
23 #include <rte_config.h>
24 
25 #include <rte_common.h>
26 #include <rte_dev.h>
27 #include <rte_memory.h>
28 #include <rte_eal.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>
34 #include <rte_pci.h>
35 #include <rte_ether.h>
36 #include <rte_ethdev.h>
37 #include <rte_ring.h>
38 #include <rte_mempool.h>
39 #include <rte_mbuf.h>
40 #include <rte_version.h>
41 #include <rte_sched.h>
42 #include <rte_net.h>
43 #include <rte_bus_pci.h>
44 #include <rte_flow.h>
45 
46 #include <vnet/devices/devices.h>
47 
48 #if CLIB_DEBUG > 0
49 #define always_inline static inline
50 #else
51 #define always_inline static inline __attribute__ ((__always_inline__))
52 #endif
53 
54 #include <vlib/pci/pci.h>
55 #include <vnet/flow/flow.h>
56 
60 
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) \
70  _ ("net_ice", ICE) \
71  _ ("net_iavf", IAVF) \
72  _ ("net_virtio", VIRTIO) \
73  _ ("net_enic", ENIC) \
74  _ ("net_vmxnet3", VMXNET3) \
75  _ ("AF_PACKET PMD", AF_PACKET) \
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) \
83  _ ("net_ena", ENA) \
84  _ ("net_failsafe", FAILSAFE) \
85  _ ("net_liovf", LIOVF_ETHER) \
86  _ ("net_qede", QEDE) \
87  _ ("net_netvsc", NETVSC) \
88  _ ("net_bnxt", BNXT)
89 
90 typedef enum
91 {
93 #define _(s,f) VNET_DPDK_PMD_##f,
95 #undef _
96  VNET_DPDK_PMD_UNKNOWN, /* must be last */
97 } dpdk_pmd_t;
98 
99 typedef enum
100 {
120 
121 typedef uint16_t dpdk_portid_t;
122 
123 #define foreach_dpdk_device_flags \
124  _( 0, ADMIN_UP, "admin-up") \
125  _( 1, PROMISC, "promisc") \
126  _( 2, PMD, "pmd") \
127  _( 3, PMD_INIT_FAIL, "pmd-init-fail") \
128  _( 4, MAYBE_MULTISEG, "maybe-multiseg") \
129  _( 5, HAVE_SUBIF, "subif") \
130  _( 9, TX_OFFLOAD, "tx-offload") \
131  _(10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
132  _(11, RX_FLOW_OFFLOAD, "rx-flow-offload") \
133  _(12, RX_IP4_CKSUM, "rx-ip4-cksum")
134 
135 enum
136 {
137 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
139 #undef _
140 };
141 
142 typedef struct
143 {
146  struct rte_flow *handle;
148 
149 typedef struct
150 {
155 
156 typedef struct
157 {
158  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
161 
162 typedef struct
163 {
164  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
167 
168 typedef struct
169 {
170  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
171 
174 
175  /* Instance ID to access internal device array. */
177 
180 
181  /* next node index if we decide to steal the rx graph arc */
183 
187 
188  /* DPDK device port number */
192 
193  CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
196 
199 
200  /* number of sub-interfaces */
202 
203  /* PMD related */
204  struct rte_eth_conf port_conf;
205  struct rte_eth_txconf tx_conf;
206 
207  /* flow related */
211  u32 *parked_lookup_indexes; /* vector */
213  struct rte_flow_error last_flow_error;
214 
215  /* af_packet instance number */
217 
218  struct rte_eth_link link;
220 
221  struct rte_eth_stats stats;
222  struct rte_eth_stats last_stats;
223  struct rte_eth_xstat *xstats;
226 
227  /* mac address */
229 
230  /* error string */
232 } dpdk_device_t;
233 
234 #define DPDK_STATS_POLL_INTERVAL (10.0)
235 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
236 
237 #define DPDK_LINK_POLL_INTERVAL (3.0)
238 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
239 
240 #define foreach_dpdk_device_config_item \
241  _ (num_rx_queues) \
242  _ (num_tx_queues) \
243  _ (num_rx_desc) \
244  _ (num_tx_desc) \
245  _ (rss_fn)
246 
247 typedef struct
248 {
249  vlib_pci_addr_t pci_addr;
253 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
254 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
255 #define DPDK_DEVICE_VLAN_STRIP_ON 2
256 
257 #define _(x) uword x;
259 #undef _
264 
265 #define DPDK_DEVICE_TSO_DEFAULT 0
266 #define DPDK_DEVICE_TSO_OFF 1
267 #define DPDK_DEVICE_TSO_ON 2
269 
270 typedef struct
271 {
272 
273  /* Config stuff */
280 
281  /* Required config parameters */
287 
288  /*
289  * format interface names ala xxxEthernet%d/%d/%d instead of
290  * xxxEthernet%x/%x/%x.
291  */
293 
294  /* per-device config */
298 
299  /* devices blacklist by pci vendor_id, device_id */
301 
303 
305 
306 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
307 
308 typedef struct
309 {
310  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
311  struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
318 
319 typedef struct
320 {
321 
322  /* Devices */
325 
326  /* buffer flags template, configurable to enable/disable tcp / udp cksum */
328 
329  /*
330  * flag indicating that a posted admin up/down
331  * (via post_sw_interface_set_flags) is in progress
332  */
334 
335  /* control interval of dpdk link state and stat polling */
338 
339  /* convenience */
343 
344  /* API message ID base */
346 
347  /* logging */
349 } dpdk_main_t;
350 
351 extern dpdk_main_t dpdk_main;
352 
353 typedef struct
354 {
358  struct rte_mbuf mb;
359  /* Copy of VLIB buffer; packet data stored in pre_data. */
361  u8 data[256]; /* First 256 data bytes, used for hexdump */
363 
364 typedef struct
365 {
369  struct rte_mbuf mb;
370  vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
371  u8 data[256]; /* First 256 data bytes, used for hexdump */
373 
374 void dpdk_device_setup (dpdk_device_t * xd);
375 void dpdk_device_start (dpdk_device_t * xd);
376 void dpdk_device_stop (dpdk_device_t * xd);
378  enum rte_eth_event_type type,
379  void *param, void *ret_param);
380 
381 #define foreach_dpdk_error \
382  _(NONE, "no error") \
383  _(RX_PACKET_ERROR, "Rx packet errors") \
384  _(RX_BAD_FCS, "Rx bad fcs") \
385  _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
386  _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
387  _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
388  _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
389 
390 typedef enum
391 {
392 #define _(f,s) DPDK_ERROR_##f,
394 #undef _
396 } dpdk_error_t;
397 
398 #define dpdk_log_err(...) \
399  vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
400 #define dpdk_log_warn(...) \
401  vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
402 #define dpdk_log_notice(...) \
403  vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
404 #define dpdk_log_info(...) \
405  vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
406 
407 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
408 
409 #define foreach_dpdk_rss_hf \
410  _(0, ETH_RSS_FRAG_IPV4, "ipv4-frag") \
411  _(1, ETH_RSS_NONFRAG_IPV4_TCP, "ipv4-tcp") \
412  _(2, ETH_RSS_NONFRAG_IPV4_UDP, "ipv4-udp") \
413  _(3, ETH_RSS_NONFRAG_IPV4_SCTP, "ipv4-sctp") \
414  _(4, ETH_RSS_NONFRAG_IPV4_OTHER, "ipv4-other") \
415  _(5, ETH_RSS_IPV4, "ipv4") \
416  _(6, ETH_RSS_IPV6_TCP_EX, "ipv6-tcp-ex") \
417  _(7, ETH_RSS_IPV6_UDP_EX, "ipv6-udp-ex") \
418  _(8, ETH_RSS_FRAG_IPV6, "ipv6-frag") \
419  _(9, ETH_RSS_NONFRAG_IPV6_TCP, "ipv6-tcp") \
420  _(10, ETH_RSS_NONFRAG_IPV6_UDP, "ipv6-udp") \
421  _(11, ETH_RSS_NONFRAG_IPV6_SCTP, "ipv6-sctp") \
422  _(12, ETH_RSS_NONFRAG_IPV6_OTHER, "ipv6-other") \
423  _(13, ETH_RSS_IPV6_EX, "ipv6-ex") \
424  _(14, ETH_RSS_IPV6, "ipv6") \
425  _(15, ETH_RSS_L2_PAYLOAD, "l2-payload") \
426  _(16, ETH_RSS_PORT, "port") \
427  _(17, ETH_RSS_VXLAN, "vxlan") \
428  _(18, ETH_RSS_GENEVE, "geneve") \
429  _(19, ETH_RSS_NVGRE, "nvgre") \
430  _(20, ETH_RSS_GTPU, "gtpu") \
431  _(60, ETH_RSS_L4_DST_ONLY, "l4-dst-only") \
432  _(61, ETH_RSS_L4_SRC_ONLY, "l4-src-only") \
433  _(62, ETH_RSS_L3_DST_ONLY, "l3-dst-only") \
434  _(63, ETH_RSS_L3_SRC_ONLY, "l3-src-only")
435 
448 
450 
451 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
452  *info);
453 void dpdk_cli_reference (void);
454 
455 #if CLI_DEBUG
456 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
457 void dpdk_buffer_poison_trajectory_all (void);
458 #endif
459 
460 #endif /* __included_dpdk_h__ */
461 
462 /*
463  * fd.io coding-style-patch-verification: ON
464  *
465  * Local Variables:
466  * eval: (c-set-style "gnu")
467  * End:
468  */
#define foreach_dpdk_device_flags
Definition: dpdk.h:123
u8 * default_mac_address
Definition: dpdk.h:228
format_function_t format_dpdk_tx_trace
Definition: dpdk.h:439
f64 time_last_link_update
Definition: dpdk.h:219
format_function_t format_dpdk_flow
Definition: dpdk.h:443
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
format_function_t format_dpdk_tx_offload_caps
Definition: dpdk.h:446
u8 * eal_init_args_str
Definition: dpdk.h:275
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:103
u8 interface_name_format_decimal
Definition: dpdk.h:292
dpdk_main_t dpdk_main
Definition: init.c:46
vlib_node_registration_t admin_up_down_process_node
(constructor) VLIB_REGISTER_NODE (admin_up_down_process_node)
Definition: device.c:763
vnet_device_class_t dpdk_device_class
u32 sw_if_index
Definition: dpdk.h:179
#define foreach_dpdk_error
Definition: dpdk.h:381
dpdk_error_t
Definition: dpdk.h:390
u8 buffer_pool_index
Definition: dpdk.h:159
u16 flags
Definition: dpdk.h:186
clib_error_t * errors
Definition: dpdk.h:231
u32 per_interface_next_index
Definition: dpdk.h:182
u8 enable_tcp_udp_checksum
Definition: dpdk.h:278
u32 supported_flow_actions
Definition: dpdk.h:208
struct rte_flow * handle
Definition: dpdk.h:146
format_function_t format_dpdk_rte_mbuf
Definition: dpdk.h:441
u16 num_subifs
Definition: dpdk.h:201
struct _vnet_device_class vnet_device_class_t
u32 * blacklist_by_pci_vendor_and_device
Definition: dpdk.h:300
unsigned char u8
Definition: types.h:56
u8 data[128]
Definition: ipsec_types.api:89
double f64
Definition: types.h:142
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
u32 vlib_log_class_t
Definition: vlib.h:51
foreach_dpdk_device_config_item clib_bitmap_t * workers
Definition: dpdk.h:260
dpdk_config_main_t dpdk_config_main
Definition: init.c:47
dpdk_portid_t port_id
Definition: dpdk.h:189
vlib_node_registration_t dpdk_input_node
(constructor) VLIB_REGISTER_NODE (dpdk_input_node)
Definition: node.c:478
dpdk_device_config_t default_devconf
Definition: dpdk.h:295
u32 buffer_index
Definition: dpdk.h:355
f64 stat_poll_interval
Definition: dpdk.h:337
u16 rx_q_used
Definition: dpdk.h:184
unsigned int u32
Definition: types.h:88
i16 buffer_advance
Definition: dpdk.h:153
format_function_t format_dpdk_rx_rte_mbuf
Definition: dpdk.h:442
clib_error_t * unformat_rss_fn(unformat_input_t *input, uword *rss_fn)
Definition: format.c:919
u32 parked_loop_count
Definition: dpdk.h:212
u32 device_index
Definition: dpdk.h:176
#define DPDK_RX_BURST_SZ
Definition: dpdk.h:306
f64 time_last_stats_update
Definition: dpdk.h:224
vl_api_fib_path_type_t type
Definition: fib_types.api:123
vlib_pci_addr_t pci_addr
Definition: dpdk.h:249
u8 ** eal_init_args
Definition: dpdk.h:274
dpdk_per_thread_data_t * per_thread_data
Definition: dpdk.h:324
void dpdk_device_stop(dpdk_device_t *xd)
Definition: common.c:200
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
#define foreach_dpdk_pmd
Definition: dpdk.h:61
vlib_buffer_t buffer_template
Definition: dpdk.h:316
dpdk_port_type_t port_type
Definition: dpdk.h:225
dpdk_tx_queue_t * tx_queues
Definition: dpdk.h:173
signed char i8
Definition: types.h:45
u16 tx_q_used
Definition: dpdk.h:185
u16 nb_rx_desc
Definition: dpdk.h:195
uint16_t dpdk_portid_t
Definition: dpdk.h:121
u32 hw_if_index
Definition: dpdk.h:178
u16 af_packet_instance_num
Definition: dpdk.h:216
u32 num_crypto_mbufs
Definition: dpdk.h:286
Definition: dpdk.h:142
dpdk_device_t * devices
Definition: dpdk.h:323
dpdk_flow_lookup_entry_t * flow_lookup_entries
Definition: dpdk.h:210
u8 nchannels_set_manually
Definition: dpdk.h:283
u32 * parked_lookup_indexes
Definition: dpdk.h:211
dpdk_device_config_t * dev_confs
Definition: dpdk.h:296
dpdk_pmd_t pmd
Definition: dpdk.h:190
u32 flow_index
Definition: dpdk.h:144
format_function_t format_dpdk_device_errors
Definition: dpdk.h:438
struct rte_pci_device * dpdk_get_pci_device(const struct rte_eth_dev_info *info)
Definition: common.c:252
void dpdk_device_setup(dpdk_device_t *xd)
Definition: common.c:39
u8 coremask_set_manually
Definition: dpdk.h:282
dpdk_pmd_t
Definition: dpdk.h:90
format_function_t format_dpdk_device
Definition: dpdk.h:437
int dpdk_port_state_callback(dpdk_portid_t port_id, enum rte_eth_event_type type, void *param, void *ret_param)
Definition: common.c:242
format_function_t format_dpdk_rss_hf_name
Definition: dpdk.h:444
struct rte_eth_xstat * xstats
Definition: dpdk.h:223
u8 * interface_name_suffix
Definition: dpdk.h:198
u16 device_index
Definition: dpdk.h:367
format_function_t format_dpdk_device_name
Definition: dpdk.h:436
vlib_log_class_t log_default
Definition: dpdk.h:348
vlib_buffer_t buffer
Definition: dpdk.h:370
void dpdk_update_link_state(dpdk_device_t *xd, f64 now)
Definition: init.c:1532
u32 buffer_index
Definition: dpdk.h:366
format_function_t format_dpdk_rx_trace
Definition: dpdk.h:440
u8 * name
Definition: dpdk.h:197
vlib_buffer_t buffer
Definition: dpdk.h:360
dpdk_port_type_t
Definition: dpdk.h:99
struct _vlib_node_registration vlib_node_registration_t
Definition: dpdk.h:149
void dpdk_device_start(dpdk_device_t *xd)
Definition: common.c:166
u8 admin_up_down_in_progress
Definition: dpdk.h:333
u8 no_tx_checksum_offload
Definition: dpdk.h:279
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
format_function_t format_dpdk_rx_offload_caps
Definition: dpdk.h:445
u16 device_index
Definition: dpdk.h:356
clib_spinlock_t lock
Definition: dpdk.h:165
u32 buffer_flags_template
Definition: dpdk.h:327
void dpdk_cli_reference(void)
Definition: cli.c:389
u16 next_index
Definition: dpdk.h:152
vnet_flow_dev_ops_function_t dpdk_flow_ops_fn
Definition: dpdk.h:447
#define foreach_dpdk_device_config_item
Definition: dpdk.h:240
uword clib_bitmap_t
Definition: bitmap.h:50
dpdk_flow_entry_t * flow_entries
Definition: dpdk.h:209
i8 cpu_socket
Definition: dpdk.h:191
u16 msg_id_base
Definition: dpdk.h:345
dpdk_rx_queue_t * rx_queues
Definition: dpdk.h:172
u8 * uio_driver_name
Definition: dpdk.h:276
u8 queue_index
Definition: dpdk.h:357
vnet_main_t * vnet_main
Definition: dpdk.h:341
u16 nb_tx_desc
Definition: dpdk.h:194
uword * device_config_index_by_pci_addr
Definition: dpdk.h:297
clib_bitmap_t * rss_queues
Definition: dpdk.h:263
u32 flow_id
Definition: dpdk.h:151
f64 link_state_poll_interval
Definition: dpdk.h:336
u32 mark
Definition: dpdk.h:145
dpdk_config_main_t * conf
Definition: dpdk.h:342
signed short i16
Definition: types.h:46
int() vnet_flow_dev_ops_function_t(struct vnet_main_t *vnm, vnet_flow_dev_op_t op, u32 hw_if_index, u32 index, uword *private_data)
Definition: interface.h:105
u16 queue_index
Definition: dpdk.h:368
vlib_main_t * vlib_main
Definition: dpdk.h:340