FD.io VPP  v17.10-9-gd594711
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 #include <rte_config.h>
22 
23 #include <rte_common.h>
24 #include <rte_dev.h>
25 #include <rte_memory.h>
26 #include <rte_eal.h>
27 #include <rte_per_lcore.h>
28 #include <rte_cycles.h>
29 #include <rte_lcore.h>
30 #include <rte_per_lcore.h>
31 #include <rte_interrupts.h>
32 #include <rte_pci.h>
33 #include <rte_ether.h>
34 #include <rte_ethdev.h>
35 #include <rte_ring.h>
36 #include <rte_mempool.h>
37 #include <rte_mbuf.h>
38 #include <rte_version.h>
39 #include <rte_eth_bond.h>
40 #include <rte_sched.h>
41 #include <rte_net.h>
42 
43 #include <vnet/unix/pcap.h>
44 #include <vnet/devices/devices.h>
45 
46 #if CLIB_DEBUG > 0
47 #define always_inline static inline
48 #else
49 #define always_inline static inline __attribute__ ((__always_inline__))
50 #endif
51 
52 #include <vlib/pci/pci.h>
53 
54 #define NB_MBUF (16<<10)
55 
58 
59 #define foreach_dpdk_pmd \
60  _ ("net_thunderx", THUNDERX) \
61  _ ("net_e1000_em", E1000EM) \
62  _ ("net_e1000_igb", IGB) \
63  _ ("net_e1000_igb_vf", IGBVF) \
64  _ ("net_ixgbe", IXGBE) \
65  _ ("net_ixgbe_vf", IXGBEVF) \
66  _ ("net_i40e", I40E) \
67  _ ("net_i40e_vf", I40EVF) \
68  _ ("net_virtio", VIRTIO) \
69  _ ("net_enic", ENIC) \
70  _ ("net_vmxnet3", VMXNET3) \
71  _ ("AF_PACKET PMD", AF_PACKET) \
72  _ ("net_bonding", BOND) \
73  _ ("net_fm10k", FM10K) \
74  _ ("net_cxgbe", CXGBE) \
75  _ ("net_mlx4", MLX4) \
76  _ ("net_mlx5", MLX5) \
77  _ ("net_dpaa2", DPAA2) \
78  _ ("net_virtio_user", VIRTIO_USER) \
79  _ ("net_vhost", VHOST_ETHER)
80 
81 typedef enum
82 {
84 #define _(s,f) VNET_DPDK_PMD_##f,
86 #undef _
87  VNET_DPDK_PMD_UNKNOWN, /* must be last */
88 } dpdk_pmd_t;
89 
90 typedef enum
91 {
106 
107 /*
108  * The header for the tx_vector in dpdk_device_t.
109  * Head and tail are indexes into the tx_vector and are of type
110  * u64 so they never overflow.
111  */
112 typedef struct
113 {
116 } tx_ring_hdr_t;
117 
118 typedef struct
119 {
120  struct rte_ring *swq;
121 
131  u32 hqos_tc_table[64];
133 
134 typedef struct
135 {
136  struct rte_ring **swq;
137  struct rte_mbuf **pkts_enq;
138  struct rte_mbuf **pkts_deq;
139  struct rte_sched_port *hqos;
146 
147 typedef struct
148 {
149  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
150  volatile u32 **lockp;
151 
152  /* Instance ID */
154 
157 
158  /* next node index if we decide to steal the rx graph arc */
160 
161  /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
162  struct rte_mbuf ***tx_vectors; /* one per worker thread */
163  struct rte_mbuf ***rx_vectors;
164 
165  /* vector of traced contexts, per device */
167 
168  dpdk_pmd_t pmd:8;
170 
172 #define DPDK_DEVICE_FLAG_ADMIN_UP (1 << 0)
173 #define DPDK_DEVICE_FLAG_PROMISC (1 << 1)
174 #define DPDK_DEVICE_FLAG_PMD (1 << 2)
175 #define DPDK_DEVICE_FLAG_PMD_INIT_FAIL (1 << 3)
176 #define DPDK_DEVICE_FLAG_MAYBE_MULTISEG (1 << 4)
177 #define DPDK_DEVICE_FLAG_HAVE_SUBIF (1 << 5)
178 #define DPDK_DEVICE_FLAG_HQOS (1 << 6)
179 #define DPDK_DEVICE_FLAG_BOND_SLAVE (1 << 7)
180 #define DPDK_DEVICE_FLAG_BOND_SLAVE_UP (1 << 8)
181 #define DPDK_DEVICE_FLAG_TX_OFFLOAD (1 << 9)
182 #define DPDK_DEVICE_FLAG_INTEL_PHDR_CKSUM (1 << 10)
183 
185  CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
186 
188 
189  /* number of sub-interfaces */
191 
192  /* PMD related */
197  struct rte_eth_conf port_conf;
198  struct rte_eth_txconf tx_conf;
199 
200  /* HQoS related */
203 
204  /* af_packet or BondEthernet instance number */
206 
207  /* Bonded interface port# of a slave -
208  only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
210 
211  struct rte_eth_link link;
213 
214  struct rte_eth_stats stats;
215  struct rte_eth_stats last_stats;
216  struct rte_eth_stats last_cleared_stats;
217  struct rte_eth_xstat *xstats;
218  struct rte_eth_xstat *last_cleared_xstats;
221 
222  /* mac address */
224 
225  /* error string */
227 } dpdk_device_t;
228 
229 #define DPDK_STATS_POLL_INTERVAL (10.0)
230 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
231 
232 #define DPDK_LINK_POLL_INTERVAL (3.0)
233 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
234 
235 typedef struct
236 {
240 
241 #ifndef DPDK_HQOS_DBG_BYPASS
242 #define DPDK_HQOS_DBG_BYPASS 0
243 #endif
244 
245 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
246 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
247 #endif
248 
250 {
253 
257 
265 
266  struct rte_sched_port_params port;
267  struct rte_sched_subport_params *subport;
268  struct rte_sched_pipe_params *pipe;
269  uint32_t *pipe_map;
271 
272 int dpdk_hqos_validate_mask (u64 mask, u32 n);
274  hqos, u32 pipe_profile_id);
279  struct rte_mbuf **pkts, u32 n_pkts);
280 
281 #define foreach_dpdk_device_config_item \
282  _ (num_rx_queues) \
283  _ (num_tx_queues) \
284  _ (num_rx_desc) \
285  _ (num_tx_desc) \
286  _ (rss_fn)
287 
288 typedef struct
289 {
290  vlib_pci_addr_t pci_addr;
293 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
294 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
295 #define DPDK_DEVICE_VLAN_STRIP_ON 2
296 
297 #define _(x) uword x;
299 #undef _
304 
305 typedef struct
306 {
307 
308  /* Config stuff */
314 
315  /* Required config parameters */
321 
322  /*
323  * format interface names ala xxxEthernet%d/%d/%d instead of
324  * xxxEthernet%x/%x/%x.
325  */
327 
328  /* per-device config */
332 
334 
336 
337 typedef struct
338 {
339 
340  /* Devices */
343 
344  /* per-thread recycle lists */
346 
347  /* per-thread buffer templates */
349 
350  /* buffer flags template, configurable to enable/disable tcp / udp cksum */
352 
353  /* vlib buffer free list, must be same size as an rte_mbuf */
355 
356  /* Ethernet input node index */
358 
359  /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
365 
366  /*
367  * flag indicating that a posted admin up/down
368  * (via post_sw_interface_set_flags) is in progress
369  */
371 
373 
374  /* which cpus are running I/O TX */
377 
378  /* control interval of dpdk link state and stat polling */
381 
382  /* Sleep for this many usec after each device poll */
384 
385  /* convenience */
389 
390  /* mempool */
391  struct rte_mempool **pktmbuf_pools;
392 
393  /* API message ID base */
395 } dpdk_main_t;
396 
397 extern dpdk_main_t dpdk_main;
398 
399 typedef struct
400 {
404  struct rte_mbuf mb;
405  /* Copy of VLIB buffer; packet data stored in pre_data. */
408 
409 typedef struct
410 {
414  struct rte_mbuf mb;
415  vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
416  u8 data[256]; /* First 256 data bytes, used for hexdump */
418 
419 void dpdk_device_setup (dpdk_device_t * xd);
420 void dpdk_device_start (dpdk_device_t * xd);
421 void dpdk_device_stop (dpdk_device_t * xd);
422 
423 #if DPDK_VOID_CALLBACK
424 void dpdk_port_state_callback (uint8_t port_id,
425  enum rte_eth_event_type type, void *param);
426 #else
427 int dpdk_port_state_callback (uint8_t port_id,
428  enum rte_eth_event_type type,
429  void *param, void *ret_param);
430 #endif
431 
432 #define foreach_dpdk_error \
433  _(NONE, "no error") \
434  _(RX_PACKET_ERROR, "Rx packet errors") \
435  _(RX_BAD_FCS, "Rx bad fcs") \
436  _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
437  _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
438  _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
439  _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
440 
441 typedef enum
442 {
443 #define _(f,s) DPDK_ERROR_##f,
445 #undef _
447 } dpdk_error_t;
448 
449 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
450 
462 
463 uword
466 
467 clib_error_t *dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
468  unsigned socket_id);
469 
470 #if CLI_DEBUG
471 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
472 void dpdk_buffer_poison_trajectory_all (void);
473 #endif
474 
475 #endif /* __included_dpdk_h__ */
476 
477 /*
478  * fd.io coding-style-patch-verification: ON
479  *
480  * Local Variables:
481  * eval: (c-set-style "gnu")
482  * End:
483  */
u32 ** d_trace_buffers
Definition: dpdk.h:166
u8 * default_mac_address
Definition: dpdk.h:223
f64 time_last_link_update
Definition: dpdk.h:212
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:231
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:68
u8 * eal_init_args_str
Definition: dpdk.h:310
vlib_buffer_t buffer
Definition: dpdk.h:406
u8 interface_name_format_decimal
Definition: dpdk.h:326
dpdk_main_t dpdk_main
Definition: init.c:37
int dpdk_hqos_validate_mask(u64 mask, u32 n)
Definition: hqos.c:168
u8 use_rss
Definition: dpdk.h:372
vnet_device_class_t dpdk_device_class
#define foreach_dpdk_error
Definition: dpdk.h:432
dpdk_error_t
Definition: dpdk.h:441
PCAP utility definitions.
u16 flags
Definition: dpdk.h:171
dpdk_device_and_queue_t ** devices_by_hqos_cpu
Definition: dpdk.h:342
struct _vlib_node_registration vlib_node_registration_t
clib_error_t * errors
Definition: dpdk.h:226
struct rte_sched_port_params port
Definition: dpdk.h:266
u32 per_interface_next_index
Definition: dpdk.h:159
u8 enable_tcp_udp_checksum
Definition: dpdk.h:313
struct rte_mbuf ** pkts_enq
Definition: dpdk.h:137
struct rte_ring ** swq
Definition: dpdk.h:136
vlib_buffer_t * buffer_templates
Definition: dpdk.h:348
struct rte_sched_port * hqos
Definition: dpdk.h:139
u64 tx_tail
Definition: dpdk.h:115
u8 *( format_function_t)(u8 *s, va_list *args)
Definition: format.h:48
struct rte_eth_xstat * last_cleared_xstats
Definition: dpdk.h:218
format_function_t format_dpdk_rte_mbuf
Definition: dpdk.h:456
dpdk_device_config_hqos_t hqos
Definition: dpdk.h:302
u16 num_subifs
Definition: dpdk.h:190
struct _vnet_device_class vnet_device_class_t
u8 * pcap_filename
Definition: dpdk.h:362
format_function_t format_dpdk_tx_dma_trace
Definition: dpdk.h:454
u8 port_id
Definition: dpdk.h:205
struct rte_sched_pipe_params * pipe
Definition: dpdk.h:268
struct rte_mbuf *** tx_vectors
Definition: dpdk.h:162
foreach_dpdk_device_config_item clib_bitmap_t * workers
Definition: dpdk.h:300
PCAP main state data structure.
Definition: pcap.h:122
dpdk_config_main_t dpdk_config_main
Definition: dpdk.h:335
vlib_node_registration_t dpdk_input_node
(constructor) VLIB_REGISTER_NODE (dpdk_input_node)
Definition: node.c:679
struct rte_mbuf ** pkts_deq
Definition: dpdk.h:138
dpdk_device_config_t default_devconf
Definition: dpdk.h:329
f64 stat_poll_interval
Definition: dpdk.h:380
u32 pcap_pkts_to_capture
Definition: dpdk.h:364
char i8
Definition: types.h:45
u16 rx_q_used
Definition: dpdk.h:194
unsigned long u64
Definition: types.h:89
format_function_t format_dpdk_rx_rte_mbuf
Definition: dpdk.h:457
clib_error_t * unformat_rss_fn(unformat_input_t *input, uword *rss_fn)
Definition: format.c:742
u32 device_index
Definition: dpdk.h:153
dpdk_device_hqos_per_worker_thread_t * hqos_wt
Definition: dpdk.h:201
f64 time_last_stats_update
Definition: dpdk.h:219
u32 pcap_sw_if_index
Definition: dpdk.h:363
u32 vlib_sw_if_index
Definition: dpdk.h:156
vlib_pci_addr_t pci_addr
Definition: dpdk.h:290
format_function_t format_dpdk_rx_dma_trace
Definition: dpdk.h:455
u8 ** eal_init_args
Definition: dpdk.h:309
void dpdk_device_stop(dpdk_device_t *xd)
Definition: common.c:163
pcap_main_t pcap_main
Definition: dpdk.h:361
struct _unformat_input_t unformat_input_t
void dpdk_hqos_metadata_set(dpdk_device_hqos_per_worker_thread_t *hqos, struct rte_mbuf **pkts, u32 n_pkts)
Definition: hqos.c:641
#define foreach_dpdk_pmd
Definition: dpdk.h:59
dpdk_port_type_t port_type
Definition: dpdk.h:220
u16 tx_q_used
Definition: dpdk.h:193
u16 nb_rx_desc
Definition: dpdk.h:195
u32 hw_if_index
Definition: dpdk.h:155
u32 ** recycle
Definition: dpdk.h:345
u8 bond_port
Definition: dpdk.h:209
dpdk_device_t * devices
Definition: dpdk.h:341
vlib_main_t * vm
Definition: buffer.c:283
u8 nchannels_set_manually
Definition: dpdk.h:317
u16 * cpu_socket_id_by_queue
Definition: dpdk.h:196
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:150
dpdk_device_config_t * dev_confs
Definition: dpdk.h:330
struct rte_mbuf *** rx_vectors
Definition: dpdk.h:163
format_function_t format_dpdk_device_errors
Definition: dpdk.h:453
void dpdk_device_setup(dpdk_device_t *xd)
Definition: common.c:39
u8 coremask_set_manually
Definition: dpdk.h:316
dpdk_pmd_t
Definition: dpdk.h:81
uword admin_up_down_process(vlib_main_t *vm, vlib_node_runtime_t *rt, vlib_frame_t *f)
Definition: device.c:799
format_function_t format_dpdk_device
Definition: dpdk.h:452
int dpdk_port_state_callback(uint8_t port_id, enum rte_eth_event_type type, void *param, void *ret_param)
Definition: common.c:301
struct rte_eth_xstat * xstats
Definition: dpdk.h:217
u8 * interface_name_suffix
Definition: dpdk.h:187
format_function_t format_dpdk_device_name
Definition: dpdk.h:451
void dpdk_device_config_hqos_default(dpdk_device_config_hqos_t *hqos)
Definition: hqos.c:205
unsigned int u32
Definition: types.h:88
int hqos_cpu_count
Definition: dpdk.h:376
u64 tx_head
Definition: dpdk.h:114
u32 poll_sleep_usec
Definition: dpdk.h:383
struct rte_mempool ** pktmbuf_pools
Definition: dpdk.h:391
dpdk_device_hqos_per_hqos_thread_t * hqos_ht
Definition: dpdk.h:202
void dpdk_update_link_state(dpdk_device_t *xd, f64 now)
Definition: init.c:1252
clib_error_t * dpdk_port_setup_hqos(dpdk_device_t *xd, dpdk_device_config_hqos_t *hqos)
Definition: hqos.c:247
u64 uword
Definition: types.h:112
dpdk_port_type_t
Definition: dpdk.h:90
void dpdk_device_start(dpdk_device_t *xd)
Definition: common.c:119
clib_error_t * dpdk_buffer_pool_create(vlib_main_t *vm, unsigned num_mbufs, unsigned socket_id)
Definition: buffer.c:413
unsigned short u16
Definition: types.h:57
vlib_buffer_t buffer
Definition: dpdk.h:415
u32 ethernet_input_node_index
Definition: dpdk.h:357
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
u8 admin_up_down_in_progress
Definition: dpdk.h:370
uint32_t * pipe_map
Definition: dpdk.h:269
u32 buffer_flags_template
Definition: dpdk.h:351
u32 vlib_buffer_free_list_index
Definition: dpdk.h:354
int hqos_cpu_first_index
Definition: dpdk.h:375
struct rte_sched_subport_params * subport
Definition: dpdk.h:267
#define foreach_dpdk_device_config_item
Definition: dpdk.h:281
uword clib_bitmap_t
Definition: bitmap.h:50
i8 cpu_socket
Definition: dpdk.h:169
u16 msg_id_base
Definition: dpdk.h:394
u8 * uio_driver_name
Definition: dpdk.h:311
unformat_function_t unformat_dpdk_log_level
Definition: dpdk.h:458
int tx_pcap_enable
Definition: dpdk.h:360
vnet_main_t * vnet_main
Definition: dpdk.h:387
u16 nb_tx_desc
Definition: dpdk.h:184
clib_error_t * unformat_hqos(unformat_input_t *input, dpdk_device_config_hqos_t *hqos)
Definition: format.c:779
uword * device_config_index_by_pci_addr
Definition: dpdk.h:331
f64 link_state_poll_interval
Definition: dpdk.h:379
dpdk_config_main_t * conf
Definition: dpdk.h:388
vlib_main_t * vlib_main
Definition: dpdk.h:386