FD.io VPP  v19.08.3-2-gbabecb413
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_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) \
82  _ ("net_ena", ENA) \
83  _ ("net_failsafe", FAILSAFE) \
84  _ ("net_liovf", LIOVF_ETHER) \
85  _ ("net_qede", QEDE) \
86  _ ("net_netvsc", NETVSC)
87 
88 typedef enum
89 {
91 #define _(s,f) VNET_DPDK_PMD_##f,
93 #undef _
94  VNET_DPDK_PMD_UNKNOWN, /* must be last */
95 } dpdk_pmd_t;
96 
97 typedef enum
98 {
118 
119 typedef uint16_t dpdk_portid_t;
120 
121 typedef struct
122 {
123  /* Required for vec_validate_aligned */
124  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
125 
126  struct rte_ring *swq;
127 
137  u32 hqos_tc_table[64];
139 
140 typedef struct
141 {
142  /* Required for vec_validate_aligned */
143  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
144  struct rte_ring **swq;
145  struct rte_mbuf **pkts_enq;
146  struct rte_mbuf **pkts_deq;
147  struct rte_sched_port *hqos;
154 
155 #define foreach_dpdk_device_flags \
156  _( 0, ADMIN_UP, "admin-up") \
157  _( 1, PROMISC, "promisc") \
158  _( 2, PMD, "pmd") \
159  _( 3, PMD_INIT_FAIL, "pmd-init-fail") \
160  _( 4, MAYBE_MULTISEG, "maybe-multiseg") \
161  _( 5, HAVE_SUBIF, "subif") \
162  _( 6, HQOS, "hqos") \
163  _( 9, TX_OFFLOAD, "tx-offload") \
164  _(10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
165  _(11, RX_FLOW_OFFLOAD, "rx-flow-offload") \
166  _(12, RX_IP4_CKSUM, "rx-ip4-cksum")
167 
168 enum
169 {
170 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
172 #undef _
173 };
174 
175 typedef struct
176 {
179  struct rte_flow *handle;
181 
182 typedef struct
183 {
188 
189 typedef struct
190 {
191  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
192  volatile u32 **lockp;
193 
194  /* Instance ID to access internal device array. */
196 
197  /* DPDK device port number */
199 
202 
203  /* next node index if we decide to steal the rx graph arc */
205 
208 
210 
212  CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
213 
216 
217  /* number of sub-interfaces */
219 
220  /* PMD related */
226  struct rte_eth_conf port_conf;
227  struct rte_eth_txconf tx_conf;
228 
229  /* flow related */
233  u32 *parked_lookup_indexes; /* vector */
235  struct rte_flow_error last_flow_error;
236 
237  /* HQoS related */
240 
241  /* af_packet instance number */
243 
244  struct rte_eth_link link;
246 
247  struct rte_eth_stats stats;
248  struct rte_eth_stats last_stats;
249  struct rte_eth_xstat *xstats;
252 
253  /* mac address */
255 
256  /* error string */
258 } dpdk_device_t;
259 
260 #define DPDK_STATS_POLL_INTERVAL (10.0)
261 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
262 
263 #define DPDK_LINK_POLL_INTERVAL (3.0)
264 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
265 
266 typedef struct
267 {
271 
272 #ifndef DPDK_HQOS_DBG_BYPASS
273 #define DPDK_HQOS_DBG_BYPASS 0
274 #endif
275 
276 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
277 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
278 #endif
279 
281 {
284 
288 
296 
297  struct rte_sched_port_params port;
298  struct rte_sched_subport_params *subport;
299  struct rte_sched_pipe_params *pipe;
300  uint32_t *pipe_map;
302 
303 int dpdk_hqos_validate_mask (u64 mask, u32 n);
305  hqos, u32 pipe_profile_id);
306 #if 0
308 #endif
312  struct rte_mbuf **pkts, u32 n_pkts);
313 
314 #define foreach_dpdk_device_config_item \
315  _ (num_rx_queues) \
316  _ (num_tx_queues) \
317  _ (num_rx_desc) \
318  _ (num_tx_desc) \
319  _ (rss_fn)
320 
321 typedef struct
322 {
323  vlib_pci_addr_t pci_addr;
327 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
328 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
329 #define DPDK_DEVICE_VLAN_STRIP_ON 2
330 
331 #define _(x) uword x;
333 #undef _
338 #define DPDK_DEVICE_TSO_DEFAULT 0
339 #define DPDK_DEVICE_TSO_OFF 1
340 #define DPDK_DEVICE_TSO_ON 2
342 
343 typedef struct
344 {
345 
346  /* Config stuff */
353 
354  /* Required config parameters */
360 
361  /*
362  * format interface names ala xxxEthernet%d/%d/%d instead of
363  * xxxEthernet%x/%x/%x.
364  */
366 
367  /* per-device config */
371 
372  /* devices blacklist by pci vendor_id, device_id */
374 
376 
378 
379 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
380 
381 typedef struct
382 {
383  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
384  struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
391 
392 typedef struct
393 {
394 
395  /* Devices */
399 
400  /* buffer flags template, configurable to enable/disable tcp / udp cksum */
402 
403  /*
404  * flag indicating that a posted admin up/down
405  * (via post_sw_interface_set_flags) is in progress
406  */
408 
409  /* which cpus are running I/O TX */
412 
413  /* control interval of dpdk link state and stat polling */
416 
417  /* convenience */
421 
422  /* API message ID base */
424 
425  /* logging */
427 } dpdk_main_t;
428 
429 extern dpdk_main_t dpdk_main;
430 
431 typedef struct
432 {
436  struct rte_mbuf mb;
437  /* Copy of VLIB buffer; packet data stored in pre_data. */
439  u8 data[256]; /* First 256 data bytes, used for hexdump */
441 
442 typedef struct
443 {
447  struct rte_mbuf mb;
448  vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
449  u8 data[256]; /* First 256 data bytes, used for hexdump */
451 
452 void dpdk_device_setup (dpdk_device_t * xd);
453 void dpdk_device_start (dpdk_device_t * xd);
454 void dpdk_device_stop (dpdk_device_t * xd);
455 
457  enum rte_eth_event_type type,
458  void *param, void *ret_param);
459 
460 #define foreach_dpdk_error \
461  _(NONE, "no error") \
462  _(RX_PACKET_ERROR, "Rx packet errors") \
463  _(RX_BAD_FCS, "Rx bad fcs") \
464  _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
465  _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
466  _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
467  _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
468 
469 typedef enum
470 {
471 #define _(f,s) DPDK_ERROR_##f,
473 #undef _
475 } dpdk_error_t;
476 
477 #define dpdk_log_err(...) \
478  vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
479 #define dpdk_log_warn(...) \
480  vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
481 #define dpdk_log_notice(...) \
482  vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
483 #define dpdk_log_info(...) \
484  vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
485 
486 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
487 
500 
504 
505 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
506  *info);
507 void dpdk_cli_reference (void);
508 
509 #if CLI_DEBUG
510 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
511 void dpdk_buffer_poison_trajectory_all (void);
512 #endif
513 
514 #endif /* __included_dpdk_h__ */
515 
516 /*
517  * fd.io coding-style-patch-verification: ON
518  *
519  * Local Variables:
520  * eval: (c-set-style "gnu")
521  * End:
522  */
#define foreach_dpdk_device_flags
Definition: dpdk.h:155
u8 * default_mac_address
Definition: dpdk.h:254
format_function_t format_dpdk_tx_trace
Definition: dpdk.h:491
f64 time_last_link_update
Definition: dpdk.h:245
struct dpdk_device_config_hqos_t dpdk_device_config_hqos_t
format_function_t format_dpdk_flow
Definition: dpdk.h:495
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
u32 flags
Definition: vhost_user.h:141
format_function_t format_dpdk_tx_offload_caps
Definition: dpdk.h:498
u8 * eal_init_args_str
Definition: dpdk.h:348
u8 interface_name_format_decimal
Definition: dpdk.h:365
dpdk_main_t dpdk_main
Definition: init.c:45
int dpdk_hqos_validate_mask(u64 mask, u32 n)
Definition: hqos.c:168
vlib_node_registration_t admin_up_down_process_node
(constructor) VLIB_REGISTER_NODE (admin_up_down_process_node)
Definition: device.c:599
vnet_device_class_t dpdk_device_class
unsigned long u64
Definition: types.h:89
u32 sw_if_index
Definition: dpdk.h:201
#define foreach_dpdk_error
Definition: dpdk.h:460
dpdk_error_t
Definition: dpdk.h:469
u16 flags
Definition: dpdk.h:209
dpdk_device_and_queue_t ** devices_by_hqos_cpu
Definition: dpdk.h:397
clib_error_t * errors
Definition: dpdk.h:257
struct rte_sched_port_params port
Definition: dpdk.h:297
u32 per_interface_next_index
Definition: dpdk.h:204
u8 enable_tcp_udp_checksum
Definition: dpdk.h:351
struct rte_mbuf ** pkts_enq
Definition: dpdk.h:145
struct rte_ring ** swq
Definition: dpdk.h:144
struct rte_sched_port * hqos
Definition: dpdk.h:147
u8 data[128]
Definition: ipsec.api:251
u32 supported_flow_actions
Definition: dpdk.h:230
struct rte_flow * handle
Definition: dpdk.h:179
format_function_t format_dpdk_rte_mbuf
Definition: dpdk.h:493
dpdk_device_config_hqos_t hqos
Definition: dpdk.h:336
u16 num_subifs
Definition: dpdk.h:218
struct _vnet_device_class vnet_device_class_t
u32 * blacklist_by_pci_vendor_and_device
Definition: dpdk.h:373
unsigned char u8
Definition: types.h:56
double f64
Definition: types.h:142
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
struct rte_sched_pipe_params * pipe
Definition: dpdk.h:299
u32 vlib_log_class_t
Definition: vlib.h:51
foreach_dpdk_device_config_item clib_bitmap_t * workers
Definition: dpdk.h:334
dpdk_config_main_t dpdk_config_main
Definition: init.c:46
dpdk_portid_t port_id
Definition: dpdk.h:198
vlib_node_registration_t dpdk_input_node
(constructor) VLIB_REGISTER_NODE (dpdk_input_node)
Definition: node.c:477
struct rte_mbuf ** pkts_deq
Definition: dpdk.h:146
dpdk_device_config_t default_devconf
Definition: dpdk.h:368
u32 buffer_index
Definition: dpdk.h:433
f64 stat_poll_interval
Definition: dpdk.h:415
u16 rx_q_used
Definition: dpdk.h:222
unsigned int u32
Definition: types.h:88
i16 buffer_advance
Definition: dpdk.h:186
format_function_t format_dpdk_rx_rte_mbuf
Definition: dpdk.h:494
clib_error_t * unformat_rss_fn(unformat_input_t *input, uword *rss_fn)
Definition: format.c:885
u32 parked_loop_count
Definition: dpdk.h:234
dpdk_device_hqos_per_worker_thread_t * hqos_wt
Definition: dpdk.h:238
#define DPDK_RX_BURST_SZ
Definition: dpdk.h:379
f64 time_last_stats_update
Definition: dpdk.h:250
vl_api_fib_path_type_t type
Definition: fib_types.api:123
vlib_pci_addr_t pci_addr
Definition: dpdk.h:323
u8 ** eal_init_args
Definition: dpdk.h:347
dpdk_per_thread_data_t * per_thread_data
Definition: dpdk.h:398
void dpdk_device_stop(dpdk_device_t *xd)
Definition: common.c:197
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
void dpdk_hqos_metadata_set(dpdk_device_hqos_per_worker_thread_t *hqos, struct rte_mbuf **pkts, u32 n_pkts)
Definition: hqos.c:640
#define foreach_dpdk_pmd
Definition: dpdk.h:61
vlib_buffer_t buffer_template
Definition: dpdk.h:389
dpdk_port_type_t port_type
Definition: dpdk.h:251
signed char i8
Definition: types.h:45
u16 tx_q_used
Definition: dpdk.h:221
u16 nb_rx_desc
Definition: dpdk.h:223
uint16_t dpdk_portid_t
Definition: dpdk.h:119
u32 hw_if_index
Definition: dpdk.h:200
u16 af_packet_instance_num
Definition: dpdk.h:242
u32 num_crypto_mbufs
Definition: dpdk.h:359
Definition: dpdk.h:175
dpdk_device_t * devices
Definition: dpdk.h:396
dpdk_flow_lookup_entry_t * flow_lookup_entries
Definition: dpdk.h:232
u8 nchannels_set_manually
Definition: dpdk.h:356
u32 * parked_lookup_indexes
Definition: dpdk.h:233
u16 * cpu_socket_id_by_queue
Definition: dpdk.h:224
void dpdk_device_config_hqos_pipe_profile_default(dpdk_device_config_hqos_t *hqos, u32 pipe_profile_id)
Definition: hqos.c:197
volatile u32 ** lockp
Definition: dpdk.h:192
dpdk_device_config_t * dev_confs
Definition: dpdk.h:369
dpdk_pmd_t pmd
Definition: dpdk.h:206
u32 flow_index
Definition: dpdk.h:177
format_function_t format_dpdk_device_errors
Definition: dpdk.h:490
struct rte_pci_device * dpdk_get_pci_device(const struct rte_eth_dev_info *info)
Definition: common.c:249
void dpdk_device_setup(dpdk_device_t *xd)
Definition: common.c:40
u8 coremask_set_manually
Definition: dpdk.h:355
dpdk_pmd_t
Definition: dpdk.h:88
format_function_t format_dpdk_device
Definition: dpdk.h:489
int dpdk_port_state_callback(dpdk_portid_t port_id, enum rte_eth_event_type type, void *param, void *ret_param)
Definition: common.c:239
format_function_t format_dpdk_rss_hf_name
Definition: dpdk.h:496
struct rte_eth_xstat * xstats
Definition: dpdk.h:249
u8 * interface_name_suffix
Definition: dpdk.h:215
u16 device_index
Definition: dpdk.h:445
format_function_t format_dpdk_device_name
Definition: dpdk.h:488
int hqos_cpu_count
Definition: dpdk.h:411
vlib_log_class_t log_default
Definition: dpdk.h:426
dpdk_device_hqos_per_hqos_thread_t * hqos_ht
Definition: dpdk.h:239
vlib_buffer_t buffer
Definition: dpdk.h:448
void dpdk_update_link_state(dpdk_device_t *xd, f64 now)
Definition: init.c:1527
dpdk_portid_t device_index
Definition: dpdk.h:195
u32 buffer_index
Definition: dpdk.h:444
format_function_t format_dpdk_rx_trace
Definition: dpdk.h:492
u8 * name
Definition: dpdk.h:214
clib_error_t * dpdk_port_setup_hqos(dpdk_device_t *xd, dpdk_device_config_hqos_t *hqos)
Definition: hqos.c:247
vlib_buffer_t buffer
Definition: dpdk.h:438
dpdk_port_type_t
Definition: dpdk.h:97
struct _vlib_node_registration vlib_node_registration_t
Definition: dpdk.h:182
void dpdk_device_start(dpdk_device_t *xd)
Definition: common.c:161
void dpdk_device_config_hqos_default(dpdk_device_config_hqos_t *hqos)
Definition: hqos.c:205
u8 admin_up_down_in_progress
Definition: dpdk.h:407
u8 no_tx_checksum_offload
Definition: dpdk.h:352
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
format_function_t format_dpdk_rx_offload_caps
Definition: dpdk.h:497
uint32_t * pipe_map
Definition: dpdk.h:300
u16 device_index
Definition: dpdk.h:434
u32 buffer_flags_template
Definition: dpdk.h:401
void dpdk_cli_reference(void)
Definition: cli.c:1746
u16 next_index
Definition: dpdk.h:185
vnet_flow_dev_ops_function_t dpdk_flow_ops_fn
Definition: dpdk.h:499
int hqos_cpu_first_index
Definition: dpdk.h:410
struct rte_sched_subport_params * subport
Definition: dpdk.h:298
#define foreach_dpdk_device_config_item
Definition: dpdk.h:314
uword clib_bitmap_t
Definition: bitmap.h:50
dpdk_flow_entry_t * flow_entries
Definition: dpdk.h:231
i8 cpu_socket
Definition: dpdk.h:207
u16 msg_id_base
Definition: dpdk.h:423
u8 * uio_driver_name
Definition: dpdk.h:349
u8 queue_index
Definition: dpdk.h:435
vnet_main_t * vnet_main
Definition: dpdk.h:419
u16 nb_tx_desc
Definition: dpdk.h:211
clib_error_t * unformat_hqos(unformat_input_t *input, dpdk_device_config_hqos_t *hqos)
Definition: format.c:908
uword * device_config_index_by_pci_addr
Definition: dpdk.h:370
u8 * buffer_pool_for_queue
Definition: dpdk.h:225
u32 flow_id
Definition: dpdk.h:184
f64 link_state_poll_interval
Definition: dpdk.h:414
u32 mark
Definition: dpdk.h:178
dpdk_config_main_t * conf
Definition: dpdk.h:420
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:96
u16 queue_index
Definition: dpdk.h:446
vlib_main_t * vlib_main
Definition: dpdk.h:418