FD.io VPP  v19.04.4-rc0-5-ge88582fac
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_eth_bond.h>
42 #include <rte_sched.h>
43 #include <rte_net.h>
44 #include <rte_bus_pci.h>
45 #include <rte_flow.h>
46 
47 #include <vnet/devices/devices.h>
48 
49 #if CLIB_DEBUG > 0
50 #define always_inline static inline
51 #else
52 #define always_inline static inline __attribute__ ((__always_inline__))
53 #endif
54 
55 #include <vlib/pci/pci.h>
56 #include <vnet/flow/flow.h>
57 
61 
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_ice", ICE) \
72  _ ("net_virtio", VIRTIO) \
73  _ ("net_enic", ENIC) \
74  _ ("net_vmxnet3", VMXNET3) \
75  _ ("AF_PACKET PMD", AF_PACKET) \
76  _ ("net_bonding", BOND) \
77  _ ("net_fm10k", FM10K) \
78  _ ("net_cxgbe", CXGBE) \
79  _ ("net_mlx4", MLX4) \
80  _ ("net_mlx5", MLX5) \
81  _ ("net_dpaa2", DPAA2) \
82  _ ("net_virtio_user", VIRTIO_USER) \
83  _ ("net_vhost", VHOST_ETHER) \
84  _ ("net_ena", ENA) \
85  _ ("net_failsafe", FAILSAFE) \
86  _ ("net_liovf", LIOVF_ETHER) \
87  _ ("net_qede", QEDE) \
88  _ ("net_netvsc", NETVSC)
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 {
121 
122 typedef uint16_t dpdk_portid_t;
123 
124 typedef struct
125 {
126  /* Required for vec_validate_aligned */
127  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
128 
129  struct rte_ring *swq;
130 
140  u32 hqos_tc_table[64];
142 
143 typedef struct
144 {
145  /* Required for vec_validate_aligned */
146  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
147  struct rte_ring **swq;
148  struct rte_mbuf **pkts_enq;
149  struct rte_mbuf **pkts_deq;
150  struct rte_sched_port *hqos;
157 
158 #define foreach_dpdk_device_flags \
159  _( 0, ADMIN_UP, "admin-up") \
160  _( 1, PROMISC, "promisc") \
161  _( 2, PMD, "pmd") \
162  _( 3, PMD_INIT_FAIL, "pmd-init-fail") \
163  _( 4, MAYBE_MULTISEG, "maybe-multiseg") \
164  _( 5, HAVE_SUBIF, "subif") \
165  _( 6, HQOS, "hqos") \
166  _( 7, BOND_SLAVE, "bond-slave") \
167  _( 8, BOND_SLAVE_UP, "bond-slave-up") \
168  _( 9, TX_OFFLOAD, "tx-offload") \
169  _(10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
170  _(11, RX_FLOW_OFFLOAD, "rx-flow-offload") \
171  _(12, RX_IP4_CKSUM, "rx-ip4-cksum")
172 
173 enum
174 {
175 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
177 #undef _
178 };
179 
180 typedef struct
181 {
184  struct rte_flow *handle;
186 
187 typedef struct
188 {
193 
194 typedef struct
195 {
196  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
197  volatile u32 **lockp;
198 
199  /* Instance ID to access internal device array. */
201 
202  /* DPDK device port number */
204 
207 
208  /* next node index if we decide to steal the rx graph arc */
210 
213 
215 
217  CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
218 
221 
222  /* number of sub-interfaces */
224 
225  /* PMD related */
231  struct rte_eth_conf port_conf;
232  struct rte_eth_txconf tx_conf;
233 
234  /* flow related */
238  u32 *parked_lookup_indexes; /* vector */
240  struct rte_flow_error last_flow_error;
241 
242  /* HQoS related */
245 
246  /* af_packet or BondEthernet instance number */
249 
250  /* Bonded interface port# of a slave -
251  only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
253 
254  struct rte_eth_link link;
256 
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;
264 
265  /* mac address */
267 
268  /* error string */
270 } dpdk_device_t;
271 
272 #define DPDK_STATS_POLL_INTERVAL (10.0)
273 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
274 
275 #define DPDK_LINK_POLL_INTERVAL (3.0)
276 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
277 
278 typedef struct
279 {
283 
284 #ifndef DPDK_HQOS_DBG_BYPASS
285 #define DPDK_HQOS_DBG_BYPASS 0
286 #endif
287 
288 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
289 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
290 #endif
291 
293 {
296 
300 
308 
309  struct rte_sched_port_params port;
310  struct rte_sched_subport_params *subport;
311  struct rte_sched_pipe_params *pipe;
312  uint32_t *pipe_map;
314 
315 int dpdk_hqos_validate_mask (u64 mask, u32 n);
317  hqos, u32 pipe_profile_id);
318 #if 0
320 #endif
324  struct rte_mbuf **pkts, u32 n_pkts);
325 
326 #define foreach_dpdk_device_config_item \
327  _ (num_rx_queues) \
328  _ (num_tx_queues) \
329  _ (num_rx_desc) \
330  _ (num_tx_desc) \
331  _ (rss_fn)
332 
333 typedef struct
334 {
335  vlib_pci_addr_t pci_addr;
339 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
340 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
341 #define DPDK_DEVICE_VLAN_STRIP_ON 2
342 
343 #define _(x) uword x;
345 #undef _
350 
351 typedef struct
352 {
353 
354  /* Config stuff */
361 
362  /* Required config parameters */
368 
369  /*
370  * format interface names ala xxxEthernet%d/%d/%d instead of
371  * xxxEthernet%x/%x/%x.
372  */
374 
375  /* per-device config */
379 
380  /* devices blacklist by pci vendor_id, device_id */
382 
384 
386 
387 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
388 
389 typedef struct
390 {
391  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
392  struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
399 
400 typedef struct
401 {
402 
403  /* Devices */
407 
408  /* buffer flags template, configurable to enable/disable tcp / udp cksum */
410 
411  /*
412  * flag indicating that a posted admin up/down
413  * (via post_sw_interface_set_flags) is in progress
414  */
416 
417  /* which cpus are running I/O TX */
420 
421  /* control interval of dpdk link state and stat polling */
424 
425  /* convenience */
429 
430  /* API message ID base */
432 
433  /* logging */
435 } dpdk_main_t;
436 
437 extern dpdk_main_t dpdk_main;
438 
439 typedef struct
440 {
444  struct rte_mbuf mb;
445  /* Copy of VLIB buffer; packet data stored in pre_data. */
447  u8 data[256]; /* First 256 data bytes, used for hexdump */
449 
450 typedef struct
451 {
455  struct rte_mbuf mb;
456  vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
457  u8 data[256]; /* First 256 data bytes, used for hexdump */
459 
460 void dpdk_device_setup (dpdk_device_t * xd);
461 void dpdk_device_start (dpdk_device_t * xd);
462 void dpdk_device_stop (dpdk_device_t * xd);
463 
465  enum rte_eth_event_type type,
466  void *param, void *ret_param);
467 
468 #define foreach_dpdk_error \
469  _(NONE, "no error") \
470  _(RX_PACKET_ERROR, "Rx packet errors") \
471  _(RX_BAD_FCS, "Rx bad fcs") \
472  _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
473  _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
474  _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
475  _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
476 
477 typedef enum
478 {
479 #define _(f,s) DPDK_ERROR_##f,
481 #undef _
483 } dpdk_error_t;
484 
485 #define dpdk_log_err(...) \
486  vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
487 #define dpdk_log_warn(...) \
488  vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
489 #define dpdk_log_notice(...) \
490  vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
491 #define dpdk_log_info(...) \
492  vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
493 
494 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
495 
508 
512 
513 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
514  *info);
515 
516 #if CLI_DEBUG
517 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
518 void dpdk_buffer_poison_trajectory_all (void);
519 #endif
520 
521 #endif /* __included_dpdk_h__ */
522 
523 /*
524  * fd.io coding-style-patch-verification: ON
525  *
526  * Local Variables:
527  * eval: (c-set-style "gnu")
528  * End:
529  */
#define foreach_dpdk_device_flags
Definition: dpdk.h:158
u8 * default_mac_address
Definition: dpdk.h:266
format_function_t format_dpdk_tx_trace
Definition: dpdk.h:499
f64 time_last_link_update
Definition: dpdk.h:255
struct dpdk_device_config_hqos_t dpdk_device_config_hqos_t
format_function_t format_dpdk_flow
Definition: dpdk.h:503
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
u32 flags
Definition: vhost_user.h:115
format_function_t format_dpdk_tx_offload_caps
Definition: dpdk.h:506
u8 * eal_init_args_str
Definition: dpdk.h:356
u8 interface_name_format_decimal
Definition: dpdk.h:373
dpdk_main_t dpdk_main
Definition: init.c:44
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:606
vnet_device_class_t dpdk_device_class
unsigned long u64
Definition: types.h:89
u32 sw_if_index
Definition: dpdk.h:206
#define foreach_dpdk_error
Definition: dpdk.h:468
dpdk_error_t
Definition: dpdk.h:477
u16 flags
Definition: dpdk.h:214
dpdk_device_and_queue_t ** devices_by_hqos_cpu
Definition: dpdk.h:405
clib_error_t * errors
Definition: dpdk.h:269
struct rte_sched_port_params port
Definition: dpdk.h:309
u32 per_interface_next_index
Definition: dpdk.h:209
u8 enable_tcp_udp_checksum
Definition: dpdk.h:359
struct rte_mbuf ** pkts_enq
Definition: dpdk.h:148
struct rte_ring ** swq
Definition: dpdk.h:147
struct rte_sched_port * hqos
Definition: dpdk.h:150
u8 data[128]
Definition: ipsec.api:248
u32 supported_flow_actions
Definition: dpdk.h:235
u16 bond_instance_num
Definition: dpdk.h:248
struct rte_flow * handle
Definition: dpdk.h:184
struct rte_eth_xstat * last_cleared_xstats
Definition: dpdk.h:261
format_function_t format_dpdk_rte_mbuf
Definition: dpdk.h:501
dpdk_device_config_hqos_t hqos
Definition: dpdk.h:348
u16 num_subifs
Definition: dpdk.h:223
struct _vnet_device_class vnet_device_class_t
u32 * blacklist_by_pci_vendor_and_device
Definition: dpdk.h:381
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:311
u32 vlib_log_class_t
Definition: vlib.h:50
foreach_dpdk_device_config_item clib_bitmap_t * workers
Definition: dpdk.h:346
dpdk_config_main_t dpdk_config_main
Definition: init.c:45
dpdk_portid_t port_id
Definition: dpdk.h:203
vlib_node_registration_t dpdk_input_node
(constructor) VLIB_REGISTER_NODE (dpdk_input_node)
Definition: node.c:478
struct rte_mbuf ** pkts_deq
Definition: dpdk.h:149
dpdk_device_config_t default_devconf
Definition: dpdk.h:376
u32 buffer_index
Definition: dpdk.h:441
f64 stat_poll_interval
Definition: dpdk.h:423
u16 rx_q_used
Definition: dpdk.h:227
unsigned int u32
Definition: types.h:88
i16 buffer_advance
Definition: dpdk.h:191
format_function_t format_dpdk_rx_rte_mbuf
Definition: dpdk.h:502
clib_error_t * unformat_rss_fn(unformat_input_t *input, uword *rss_fn)
Definition: format.c:896
u32 parked_loop_count
Definition: dpdk.h:239
dpdk_device_hqos_per_worker_thread_t * hqos_wt
Definition: dpdk.h:243
#define DPDK_RX_BURST_SZ
Definition: dpdk.h:387
f64 time_last_stats_update
Definition: dpdk.h:262
vlib_pci_addr_t pci_addr
Definition: dpdk.h:335
dpdk_portid_t bond_port
Definition: dpdk.h:252
u8 ** eal_init_args
Definition: dpdk.h:355
dpdk_per_thread_data_t * per_thread_data
Definition: dpdk.h:406
void dpdk_device_stop(dpdk_device_t *xd)
Definition: common.c:208
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:62
vlib_buffer_t buffer_template
Definition: dpdk.h:397
dpdk_port_type_t port_type
Definition: dpdk.h:263
signed char i8
Definition: types.h:45
u16 tx_q_used
Definition: dpdk.h:226
u16 nb_rx_desc
Definition: dpdk.h:228
uint16_t dpdk_portid_t
Definition: dpdk.h:122
u32 hw_if_index
Definition: dpdk.h:205
u16 af_packet_instance_num
Definition: dpdk.h:247
u32 num_crypto_mbufs
Definition: dpdk.h:367
Definition: dpdk.h:180
dpdk_device_t * devices
Definition: dpdk.h:404
dpdk_flow_lookup_entry_t * flow_lookup_entries
Definition: dpdk.h:237
u8 nchannels_set_manually
Definition: dpdk.h:364
u32 * parked_lookup_indexes
Definition: dpdk.h:238
u16 * cpu_socket_id_by_queue
Definition: dpdk.h:229
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:197
dpdk_device_config_t * dev_confs
Definition: dpdk.h:377
dpdk_pmd_t pmd
Definition: dpdk.h:211
u32 flow_index
Definition: dpdk.h:182
format_function_t format_dpdk_device_errors
Definition: dpdk.h:498
struct rte_pci_device * dpdk_get_pci_device(const struct rte_eth_dev_info *info)
Definition: common.c:348
void dpdk_device_setup(dpdk_device_t *xd)
Definition: common.c:40
u8 coremask_set_manually
Definition: dpdk.h:363
dpdk_pmd_t
Definition: dpdk.h:90
format_function_t format_dpdk_device
Definition: dpdk.h:497
int dpdk_port_state_callback(dpdk_portid_t port_id, enum rte_eth_event_type type, void *param, void *ret_param)
Definition: common.c:338
format_function_t format_dpdk_rss_hf_name
Definition: dpdk.h:504
struct rte_eth_xstat * xstats
Definition: dpdk.h:260
u8 * interface_name_suffix
Definition: dpdk.h:220
u16 device_index
Definition: dpdk.h:453
format_function_t format_dpdk_device_name
Definition: dpdk.h:496
int hqos_cpu_count
Definition: dpdk.h:419
vlib_log_class_t log_default
Definition: dpdk.h:434
dpdk_device_hqos_per_hqos_thread_t * hqos_ht
Definition: dpdk.h:244
vlib_buffer_t buffer
Definition: dpdk.h:456
void dpdk_update_link_state(dpdk_device_t *xd, f64 now)
Definition: init.c:1398
dpdk_portid_t device_index
Definition: dpdk.h:200
u32 buffer_index
Definition: dpdk.h:452
format_function_t format_dpdk_rx_trace
Definition: dpdk.h:500
u8 * name
Definition: dpdk.h:219
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:446
dpdk_port_type_t
Definition: dpdk.h:99
struct _vlib_node_registration vlib_node_registration_t
Definition: dpdk.h:187
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:415
u8 no_tx_checksum_offload
Definition: dpdk.h:360
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
format_function_t format_dpdk_rx_offload_caps
Definition: dpdk.h:505
uint32_t * pipe_map
Definition: dpdk.h:312
u16 device_index
Definition: dpdk.h:442
u32 buffer_flags_template
Definition: dpdk.h:409
u16 next_index
Definition: dpdk.h:190
vnet_flow_dev_ops_function_t dpdk_flow_ops_fn
Definition: dpdk.h:507
int hqos_cpu_first_index
Definition: dpdk.h:418
struct rte_sched_subport_params * subport
Definition: dpdk.h:310
#define foreach_dpdk_device_config_item
Definition: dpdk.h:326
uword clib_bitmap_t
Definition: bitmap.h:50
dpdk_flow_entry_t * flow_entries
Definition: dpdk.h:236
i8 cpu_socket
Definition: dpdk.h:212
u16 msg_id_base
Definition: dpdk.h:431
u8 * uio_driver_name
Definition: dpdk.h:357
u8 queue_index
Definition: dpdk.h:443
vnet_main_t * vnet_main
Definition: dpdk.h:427
u16 nb_tx_desc
Definition: dpdk.h:216
clib_error_t * unformat_hqos(unformat_input_t *input, dpdk_device_config_hqos_t *hqos)
Definition: format.c:919
uword * device_config_index_by_pci_addr
Definition: dpdk.h:378
u8 * buffer_pool_for_queue
Definition: dpdk.h:230
u32 flow_id
Definition: dpdk.h:189
f64 link_state_poll_interval
Definition: dpdk.h:422
u32 mark
Definition: dpdk.h:183
dpdk_config_main_t * conf
Definition: dpdk.h:428
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:95
u16 queue_index
Definition: dpdk.h:454
vlib_main_t * vlib_main
Definition: dpdk.h:426