FD.io VPP  v18.10-34-gcce845e
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/unix/pcap.h>
48 #include <vnet/devices/devices.h>
49 
50 #if CLIB_DEBUG > 0
51 #define always_inline static inline
52 #else
53 #define always_inline static inline __attribute__ ((__always_inline__))
54 #endif
55 
56 #include <vlib/pci/pci.h>
57 #include <vnet/flow/flow.h>
58 
59 #define NB_MBUF (16<<10)
60 
64 
65 #define foreach_dpdk_pmd \
66  _ ("net_thunderx", THUNDERX) \
67  _ ("net_e1000_em", E1000EM) \
68  _ ("net_e1000_igb", IGB) \
69  _ ("net_e1000_igb_vf", IGBVF) \
70  _ ("net_ixgbe", IXGBE) \
71  _ ("net_ixgbe_vf", IXGBEVF) \
72  _ ("net_i40e", I40E) \
73  _ ("net_i40e_vf", I40EVF) \
74  _ ("net_virtio", VIRTIO) \
75  _ ("net_enic", ENIC) \
76  _ ("net_vmxnet3", VMXNET3) \
77  _ ("AF_PACKET PMD", AF_PACKET) \
78  _ ("net_bonding", BOND) \
79  _ ("net_fm10k", FM10K) \
80  _ ("net_cxgbe", CXGBE) \
81  _ ("net_mlx4", MLX4) \
82  _ ("net_mlx5", MLX5) \
83  _ ("net_dpaa2", DPAA2) \
84  _ ("net_virtio_user", VIRTIO_USER) \
85  _ ("net_vhost", VHOST_ETHER) \
86  _ ("net_ena", ENA) \
87  _ ("net_failsafe", FAILSAFE) \
88  _ ("net_liovf", LIOVF_ETHER) \
89  _ ("net_qede", QEDE)
90 
91 typedef enum
92 {
94 #define _(s,f) VNET_DPDK_PMD_##f,
96 #undef _
97  VNET_DPDK_PMD_UNKNOWN, /* must be last */
98 } dpdk_pmd_t;
99 
100 typedef enum
101 {
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 
172 enum
173 {
174 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
176 #undef _
177 };
178 
179 typedef struct
180 {
183  struct rte_flow *handle;
185 
186 typedef struct
187 {
192 
193 typedef struct
194 {
195  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
196  volatile u32 **lockp;
197 
198  /* Instance ID to access internal device array. */
200 
201  /* DPDK device port number */
203 
206 
207  /* next node index if we decide to steal the rx graph arc */
209 
210  dpdk_pmd_t pmd:8;
212 
214 
216  CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
217 
219 
220  /* number of sub-interfaces */
222 
223  /* PMD related */
229  struct rte_eth_conf port_conf;
230  struct rte_eth_txconf tx_conf;
231 
232  /* flow related */
236  u32 *parked_lookup_indexes; /* vector */
238  struct rte_flow_error last_flow_error;
239 
240  /* HQoS related */
243 
244  /* af_packet or BondEthernet instance number */
247 
248  /* Bonded interface port# of a slave -
249  only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
251 
252  struct rte_eth_link link;
254 
255  struct rte_eth_stats stats;
256  struct rte_eth_stats last_stats;
257  struct rte_eth_stats last_cleared_stats;
258  struct rte_eth_xstat *xstats;
259  struct rte_eth_xstat *last_cleared_xstats;
262 
263  /* mac address */
265 
266  /* error string */
268 } dpdk_device_t;
269 
270 #define DPDK_STATS_POLL_INTERVAL (10.0)
271 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
272 
273 #define DPDK_LINK_POLL_INTERVAL (3.0)
274 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
275 
276 typedef struct
277 {
281 
282 #ifndef DPDK_HQOS_DBG_BYPASS
283 #define DPDK_HQOS_DBG_BYPASS 0
284 #endif
285 
286 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
287 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
288 #endif
289 
291 {
294 
298 
306 
307  struct rte_sched_port_params port;
308  struct rte_sched_subport_params *subport;
309  struct rte_sched_pipe_params *pipe;
310  uint32_t *pipe_map;
312 
313 int dpdk_hqos_validate_mask (u64 mask, u32 n);
315  hqos, u32 pipe_profile_id);
320  struct rte_mbuf **pkts, u32 n_pkts);
321 
322 #define foreach_dpdk_device_config_item \
323  _ (num_rx_queues) \
324  _ (num_tx_queues) \
325  _ (num_rx_desc) \
326  _ (num_tx_desc) \
327  _ (rss_fn)
328 
329 typedef struct
330 {
331  vlib_pci_addr_t pci_addr;
334 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
335 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
336 #define DPDK_DEVICE_VLAN_STRIP_ON 2
337 
338 #define _(x) uword x;
340 #undef _
345 
346 typedef struct
347 {
348 
349  /* Config stuff */
356 
357  /* Required config parameters */
363 
364  /*
365  * format interface names ala xxxEthernet%d/%d/%d instead of
366  * xxxEthernet%x/%x/%x.
367  */
369 
370  /* per-device config */
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 {
397 } dpdk_pcap_t;
398 
399 typedef struct
400 {
401 
402  /* Devices */
406 
407  /* buffer flags template, configurable to enable/disable tcp / udp cksum */
409 
410  /* pcap tracing */
412 
418 
419  /*
420  * flag indicating that a posted admin up/down
421  * (via post_sw_interface_set_flags) is in progress
422  */
424 
425  /* which cpus are running I/O TX */
428 
429  /* control interval of dpdk link state and stat polling */
432 
433  /* convenience */
437 
438  /* mempool */
439  struct rte_mempool **pktmbuf_pools;
440 
441  /* API message ID base */
443 
444  /* logging */
446 } dpdk_main_t;
447 
448 extern dpdk_main_t dpdk_main;
449 
450 typedef struct
451 {
455  struct rte_mbuf mb;
456  /* Copy of VLIB buffer; packet data stored in pre_data. */
458  u8 data[256]; /* First 256 data bytes, used for hexdump */
460 
461 typedef struct
462 {
466  struct rte_mbuf mb;
467  vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
468  u8 data[256]; /* First 256 data bytes, used for hexdump */
470 
471 void dpdk_device_setup (dpdk_device_t * xd);
472 void dpdk_device_start (dpdk_device_t * xd);
473 void dpdk_device_stop (dpdk_device_t * xd);
474 
476  enum rte_eth_event_type type,
477  void *param, void *ret_param);
478 
479 #define foreach_dpdk_error \
480  _(NONE, "no error") \
481  _(RX_PACKET_ERROR, "Rx packet errors") \
482  _(RX_BAD_FCS, "Rx bad fcs") \
483  _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
484  _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
485  _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
486  _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
487 
488 typedef enum
489 {
490 #define _(f,s) DPDK_ERROR_##f,
492 #undef _
494 } dpdk_error_t;
495 
496 #define dpdk_log_err(...) \
497  vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
498 #define dpdk_log_warn(...) \
499  vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
500 #define dpdk_log_notice(...) \
501  vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
502 #define dpdk_log_info(...) \
503  vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
504 
505 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
506 
520 
524 
526  u32 elt_size, u32 num_elts,
527  u32 pool_priv_size, u16 cache_size, u8 numa,
528  struct rte_mempool **_mp,
530 
531 clib_error_t *dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
532  unsigned socket_id);
533 
534 #if CLI_DEBUG
535 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
536 void dpdk_buffer_poison_trajectory_all (void);
537 #endif
538 
539 #endif /* __included_dpdk_h__ */
540 
541 /*
542  * fd.io coding-style-patch-verification: ON
543  *
544  * Local Variables:
545  * eval: (c-set-style "gnu")
546  * End:
547  */
#define foreach_dpdk_device_flags
Definition: dpdk.h:158
u8 * default_mac_address
Definition: dpdk.h:264
format_function_t format_dpdk_tx_trace
Definition: dpdk.h:510
f64 time_last_link_update
Definition: dpdk.h:253
struct dpdk_device_config_hqos_t dpdk_device_config_hqos_t
uword( unformat_function_t)(unformat_input_t *input, va_list *args)
Definition: format.h:232
format_function_t format_dpdk_flow
Definition: dpdk.h:514
u32 vlib_log_class_t
Definition: log.h:21
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
format_function_t format_dpdk_tx_offload_caps
Definition: dpdk.h:517
u8 * eal_init_args_str
Definition: dpdk.h:351
u8 interface_name_format_decimal
Definition: dpdk.h:368
dpdk_main_t dpdk_main
Definition: init.c:42
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:625
vnet_device_class_t dpdk_device_class
unsigned long u64
Definition: types.h:89
u32 sw_if_index
Definition: dpdk.h:205
#define foreach_dpdk_error
Definition: dpdk.h:479
dpdk_error_t
Definition: dpdk.h:488
PCAP utility definitions.
u16 flags
Definition: dpdk.h:213
dpdk_device_and_queue_t ** devices_by_hqos_cpu
Definition: dpdk.h:404
clib_error_t * errors
Definition: dpdk.h:267
struct rte_sched_port_params port
Definition: dpdk.h:307
u32 per_interface_next_index
Definition: dpdk.h:208
u8 enable_tcp_udp_checksum
Definition: dpdk.h:354
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
u32 supported_flow_actions
Definition: dpdk.h:233
u8 *( format_function_t)(u8 *s, va_list *args)
Definition: format.h:48
u16 bond_instance_num
Definition: dpdk.h:246
struct rte_flow * handle
Definition: dpdk.h:183
struct rte_eth_xstat * last_cleared_xstats
Definition: dpdk.h:259
format_function_t format_dpdk_rte_mbuf
Definition: dpdk.h:512
dpdk_device_config_hqos_t hqos
Definition: dpdk.h:343
u16 num_subifs
Definition: dpdk.h:221
struct _vnet_device_class vnet_device_class_t
u8 * pcap_filename
Definition: dpdk.h:415
unsigned char u8
Definition: types.h:56
double f64
Definition: types.h:142
struct rte_sched_pipe_params * pipe
Definition: dpdk.h:309
foreach_dpdk_device_config_item clib_bitmap_t * workers
Definition: dpdk.h:341
PCAP main state data structure.
Definition: pcap.h:124
dpdk_config_main_t dpdk_config_main
Definition: init.c:43
dpdk_portid_t port_id
Definition: dpdk.h:202
vlib_node_registration_t dpdk_input_node
(constructor) VLIB_REGISTER_NODE (dpdk_input_node)
Definition: node.c:646
struct rte_mbuf ** pkts_deq
Definition: dpdk.h:149
dpdk_device_config_t default_devconf
Definition: dpdk.h:371
u32 buffer_index
Definition: dpdk.h:452
f64 stat_poll_interval
Definition: dpdk.h:431
u32 pcap_pkts_to_capture
Definition: dpdk.h:417
u16 rx_q_used
Definition: dpdk.h:225
unsigned int u32
Definition: types.h:88
i16 buffer_advance
Definition: dpdk.h:190
format_function_t format_dpdk_rx_rte_mbuf
Definition: dpdk.h:513
clib_error_t * unformat_rss_fn(unformat_input_t *input, uword *rss_fn)
Definition: format.c:878
u32 parked_loop_count
Definition: dpdk.h:237
dpdk_device_hqos_per_worker_thread_t * hqos_wt
Definition: dpdk.h:241
#define DPDK_RX_BURST_SZ
Definition: dpdk.h:379
f64 time_last_stats_update
Definition: dpdk.h:260
u32 pcap_sw_if_index
Definition: dpdk.h:416
vlib_pci_addr_t pci_addr
Definition: dpdk.h:331
dpdk_portid_t bond_port
Definition: dpdk.h:250
u32 pcap_sw_if_index
Definition: dpdk.h:395
u8 ** eal_init_args
Definition: dpdk.h:350
dpdk_per_thread_data_t * per_thread_data
Definition: dpdk.h:405
void dpdk_device_stop(dpdk_device_t *xd)
Definition: common.c:210
pcap_main_t pcap_main
Definition: dpdk.h:414
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:65
vlib_buffer_t buffer_template
Definition: dpdk.h:389
dpdk_port_type_t port_type
Definition: dpdk.h:261
signed char i8
Definition: types.h:45
u16 tx_q_used
Definition: dpdk.h:224
u16 nb_rx_desc
Definition: dpdk.h:226
uint16_t dpdk_portid_t
Definition: dpdk.h:122
u32 hw_if_index
Definition: dpdk.h:204
u32 flags
Definition: vhost_user.h:115
u16 af_packet_instance_num
Definition: dpdk.h:245
Definition: dpdk.h:179
dpdk_device_t * devices
Definition: dpdk.h:403
vlib_main_t * vm
Definition: buffer.c:294
dpdk_flow_lookup_entry_t * flow_lookup_entries
Definition: dpdk.h:235
u8 nchannels_set_manually
Definition: dpdk.h:359
u32 * parked_lookup_indexes
Definition: dpdk.h:236
u16 * cpu_socket_id_by_queue
Definition: dpdk.h:227
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:196
dpdk_device_config_t * dev_confs
Definition: dpdk.h:372
u32 flow_index
Definition: dpdk.h:181
format_function_t format_dpdk_device_errors
Definition: dpdk.h:509
void dpdk_device_setup(dpdk_device_t *xd)
Definition: common.c:40
u8 coremask_set_manually
Definition: dpdk.h:358
dpdk_pmd_t
Definition: dpdk.h:91
format_function_t format_dpdk_device
Definition: dpdk.h:508
int dpdk_port_state_callback(dpdk_portid_t port_id, enum rte_eth_event_type type, void *param, void *ret_param)
Definition: common.c:340
format_function_t format_dpdk_rss_hf_name
Definition: dpdk.h:515
struct rte_eth_xstat * xstats
Definition: dpdk.h:258
u8 * interface_name_suffix
Definition: dpdk.h:218
u16 device_index
Definition: dpdk.h:464
format_function_t format_dpdk_device_name
Definition: dpdk.h:507
void dpdk_device_config_hqos_default(dpdk_device_config_hqos_t *hqos)
Definition: hqos.c:205
int hqos_cpu_count
Definition: dpdk.h:427
vlib_log_class_t log_default
Definition: dpdk.h:445
struct rte_mempool ** pktmbuf_pools
Definition: dpdk.h:439
dpdk_device_hqos_per_hqos_thread_t * hqos_ht
Definition: dpdk.h:242
vlib_buffer_t buffer
Definition: dpdk.h:467
void dpdk_update_link_state(dpdk_device_t *xd, f64 now)
Definition: init.c:1474
dpdk_portid_t device_index
Definition: dpdk.h:199
u32 buffer_index
Definition: dpdk.h:463
format_function_t format_dpdk_rx_trace
Definition: dpdk.h:511
int pcap_enable
Definition: dpdk.h:413
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:457
dpdk_port_type_t
Definition: dpdk.h:100
struct _vlib_node_registration vlib_node_registration_t
Definition: dpdk.h:186
void dpdk_device_start(dpdk_device_t *xd)
Definition: common.c:163
pcap_main_t pcap_main
Definition: dpdk.h:396
clib_error_t * dpdk_buffer_pool_create(vlib_main_t *vm, unsigned num_mbufs, unsigned socket_id)
Definition: buffer.c:511
u8 admin_up_down_in_progress
Definition: dpdk.h:423
clib_error_t * dpdk_pool_create(vlib_main_t *vm, u8 *pool_name, u32 elt_size, u32 num_elts, u32 pool_priv_size, u16 cache_size, u8 numa, struct rte_mempool **_mp, vlib_physmem_region_index_t *pri)
Definition: buffer.c:423
u8 no_tx_checksum_offload
Definition: dpdk.h:355
u64 uword
Definition: types.h:112
format_function_t format_dpdk_rx_offload_caps
Definition: dpdk.h:516
uint32_t * pipe_map
Definition: dpdk.h:310
u16 device_index
Definition: dpdk.h:453
u32 buffer_flags_template
Definition: dpdk.h:408
u16 next_index
Definition: dpdk.h:189
vnet_flow_dev_ops_function_t dpdk_flow_ops_fn
Definition: dpdk.h:519
int hqos_cpu_first_index
Definition: dpdk.h:426
struct rte_sched_subport_params * subport
Definition: dpdk.h:308
#define foreach_dpdk_device_config_item
Definition: dpdk.h:322
uword clib_bitmap_t
Definition: bitmap.h:50
dpdk_flow_entry_t * flow_entries
Definition: dpdk.h:234
i8 cpu_socket
Definition: dpdk.h:211
u16 msg_id_base
Definition: dpdk.h:442
u8 * uio_driver_name
Definition: dpdk.h:352
unformat_function_t unformat_dpdk_log_level
Definition: dpdk.h:518
u8 queue_index
Definition: dpdk.h:454
vnet_main_t * vnet_main
Definition: dpdk.h:435
u16 nb_tx_desc
Definition: dpdk.h:215
clib_error_t * unformat_hqos(unformat_input_t *input, dpdk_device_config_hqos_t *hqos)
Definition: format.c:915
u8 vlib_physmem_region_index_t
Definition: physmem.h:43
uword * device_config_index_by_pci_addr
Definition: dpdk.h:373
u8 * buffer_pool_for_queue
Definition: dpdk.h:228
u32 flow_id
Definition: dpdk.h:188
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:94
f64 link_state_poll_interval
Definition: dpdk.h:430
u32 mark
Definition: dpdk.h:182
dpdk_config_main_t * conf
Definition: dpdk.h:436
int pcap_enable
Definition: dpdk.h:394
signed short i16
Definition: types.h:46
u16 queue_index
Definition: dpdk.h:465
vlib_main_t * vlib_main
Definition: dpdk.h:434