FD.io VPP  v18.01-8-g0eacf49
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 #if RTE_VERSION >= RTE_VERSION_NUM(17, 11, 0, 0)
43 #include <rte_bus_pci.h>
44 #endif
45 
46 #include <vnet/unix/pcap.h>
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 
57 #define NB_MBUF (16<<10)
58 
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_virtio", VIRTIO) \
72  _ ("net_enic", ENIC) \
73  _ ("net_vmxnet3", VMXNET3) \
74  _ ("AF_PACKET PMD", AF_PACKET) \
75  _ ("net_bonding", BOND) \
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 
85 typedef enum
86 {
88 #define _(s,f) VNET_DPDK_PMD_##f,
90 #undef _
91  VNET_DPDK_PMD_UNKNOWN, /* must be last */
92 } dpdk_pmd_t;
93 
94 typedef enum
95 {
110 
111 /*
112  * The header for the tx_vector in dpdk_device_t.
113  * Head and tail are indexes into the tx_vector and are of type
114  * u64 so they never overflow.
115  */
116 typedef struct
117 {
120 } tx_ring_hdr_t;
121 
122 #if RTE_VERSION < RTE_VERSION_NUM(17, 11, 0, 0)
123 typedef uint8_t dpdk_portid_t;
124 #else
125 typedef uint16_t dpdk_portid_t;
126 #endif
127 
128 typedef struct
129 {
130  struct rte_ring *swq;
131 
141  u32 hqos_tc_table[64];
143 
144 typedef struct
145 {
146  struct rte_ring **swq;
147  struct rte_mbuf **pkts_enq;
148  struct rte_mbuf **pkts_deq;
149  struct rte_sched_port *hqos;
156 
157 typedef struct
158 {
159  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
160  volatile u32 **lockp;
161 
162  /* Instance ID */
164 
167 
168  /* next node index if we decide to steal the rx graph arc */
170 
171  /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
172  struct rte_mbuf ***tx_vectors; /* one per worker thread */
173  struct rte_mbuf ***rx_vectors;
174 
175  /* vector of traced contexts, per device */
177 
178  dpdk_pmd_t pmd:8;
180 
182 #define DPDK_DEVICE_FLAG_ADMIN_UP (1 << 0)
183 #define DPDK_DEVICE_FLAG_PROMISC (1 << 1)
184 #define DPDK_DEVICE_FLAG_PMD (1 << 2)
185 #define DPDK_DEVICE_FLAG_PMD_INIT_FAIL (1 << 3)
186 #define DPDK_DEVICE_FLAG_MAYBE_MULTISEG (1 << 4)
187 #define DPDK_DEVICE_FLAG_HAVE_SUBIF (1 << 5)
188 #define DPDK_DEVICE_FLAG_HQOS (1 << 6)
189 #define DPDK_DEVICE_FLAG_BOND_SLAVE (1 << 7)
190 #define DPDK_DEVICE_FLAG_BOND_SLAVE_UP (1 << 8)
191 #define DPDK_DEVICE_FLAG_TX_OFFLOAD (1 << 9)
192 #define DPDK_DEVICE_FLAG_INTEL_PHDR_CKSUM (1 << 10)
193 
195  CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
196 
198 
199  /* number of sub-interfaces */
201 
202  /* PMD related */
208  struct rte_eth_conf port_conf;
209  struct rte_eth_txconf tx_conf;
210 
211  /* HQoS related */
214 
215  /* af_packet or BondEthernet instance number */
217 
218  /* Bonded interface port# of a slave -
219  only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
221 
222  struct rte_eth_link link;
224 
225  struct rte_eth_stats stats;
226  struct rte_eth_stats last_stats;
227  struct rte_eth_stats last_cleared_stats;
228  struct rte_eth_xstat *xstats;
229  struct rte_eth_xstat *last_cleared_xstats;
232 
233  /* mac address */
235 
236  /* error string */
238 } dpdk_device_t;
239 
240 #define DPDK_STATS_POLL_INTERVAL (10.0)
241 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
242 
243 #define DPDK_LINK_POLL_INTERVAL (3.0)
244 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
245 
246 typedef struct
247 {
251 
252 #ifndef DPDK_HQOS_DBG_BYPASS
253 #define DPDK_HQOS_DBG_BYPASS 0
254 #endif
255 
256 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
257 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
258 #endif
259 
261 {
264 
268 
276 
277  struct rte_sched_port_params port;
278  struct rte_sched_subport_params *subport;
279  struct rte_sched_pipe_params *pipe;
280  uint32_t *pipe_map;
282 
283 int dpdk_hqos_validate_mask (u64 mask, u32 n);
285  hqos, u32 pipe_profile_id);
290  struct rte_mbuf **pkts, u32 n_pkts);
291 
292 #define foreach_dpdk_device_config_item \
293  _ (num_rx_queues) \
294  _ (num_tx_queues) \
295  _ (num_rx_desc) \
296  _ (num_tx_desc) \
297  _ (rss_fn)
298 
299 typedef struct
300 {
301  vlib_pci_addr_t pci_addr;
304 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
305 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
306 #define DPDK_DEVICE_VLAN_STRIP_ON 2
307 
308 #define _(x) uword x;
310 #undef _
315 
316 typedef struct
317 {
318 
319  /* Config stuff */
326 
327  /* Required config parameters */
333 
334  /*
335  * format interface names ala xxxEthernet%d/%d/%d instead of
336  * xxxEthernet%x/%x/%x.
337  */
339 
340  /* per-device config */
344 
346 
348 
349 typedef struct
350 {
351 
352  /* Devices */
355 
356  /* per-thread recycle lists */
358 
359  /* per-thread buffer templates */
361 
362  /* buffer flags template, configurable to enable/disable tcp / udp cksum */
364 
365  /* vlib buffer free list, must be same size as an rte_mbuf */
367 
368  /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
374 
375  /*
376  * flag indicating that a posted admin up/down
377  * (via post_sw_interface_set_flags) is in progress
378  */
380 
381  /* which cpus are running I/O TX */
384 
385  /* control interval of dpdk link state and stat polling */
388 
389  /* Sleep for this many usec after each device poll */
391 
392  /* convenience */
396 
397  /* mempool */
398  struct rte_mempool **pktmbuf_pools;
399 
400  /* API message ID base */
402 } dpdk_main_t;
403 
404 extern dpdk_main_t dpdk_main;
405 
406 typedef struct
407 {
411  struct rte_mbuf mb;
412  /* Copy of VLIB buffer; packet data stored in pre_data. */
414  u8 data[256]; /* First 256 data bytes, used for hexdump */
416 
417 typedef struct
418 {
422  struct rte_mbuf mb;
423  vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
424  u8 data[256]; /* First 256 data bytes, used for hexdump */
426 
427 void dpdk_device_setup (dpdk_device_t * xd);
428 void dpdk_device_start (dpdk_device_t * xd);
429 void dpdk_device_stop (dpdk_device_t * xd);
430 
432  enum rte_eth_event_type type,
433  void *param, void *ret_param);
434 
435 #define foreach_dpdk_error \
436  _(NONE, "no error") \
437  _(RX_PACKET_ERROR, "Rx packet errors") \
438  _(RX_BAD_FCS, "Rx bad fcs") \
439  _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
440  _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
441  _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
442  _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
443 
444 typedef enum
445 {
446 #define _(f,s) DPDK_ERROR_##f,
448 #undef _
450 } dpdk_error_t;
451 
452 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
453 
465 
466 uword
469 
471  u32 elt_size, u32 num_elts,
472  u32 pool_priv_size, u16 cache_size, u8 numa,
473  struct rte_mempool **_mp,
475 
476 clib_error_t *dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
477  unsigned socket_id);
478 
479 #if CLI_DEBUG
480 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
481 void dpdk_buffer_poison_trajectory_all (void);
482 #endif
483 
484 #endif /* __included_dpdk_h__ */
485 
486 /*
487  * fd.io coding-style-patch-verification: ON
488  *
489  * Local Variables:
490  * eval: (c-set-style "gnu")
491  * End:
492  */
u32 ** d_trace_buffers
Definition: dpdk.h:176
u8 * default_mac_address
Definition: dpdk.h:234
f64 time_last_link_update
Definition: dpdk.h:223
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:321
vlib_buffer_t buffer
Definition: dpdk.h:413
u8 interface_name_format_decimal
Definition: dpdk.h:338
dpdk_main_t dpdk_main
Definition: init.c:39
int dpdk_hqos_validate_mask(u64 mask, u32 n)
Definition: hqos.c:168
vnet_device_class_t dpdk_device_class
#define foreach_dpdk_error
Definition: dpdk.h:435
dpdk_error_t
Definition: dpdk.h:444
PCAP utility definitions.
u16 flags
Definition: dpdk.h:181
dpdk_device_and_queue_t ** devices_by_hqos_cpu
Definition: dpdk.h:354
struct _vlib_node_registration vlib_node_registration_t
clib_error_t * errors
Definition: dpdk.h:237
struct rte_sched_port_params port
Definition: dpdk.h:277
u32 per_interface_next_index
Definition: dpdk.h:169
u8 enable_tcp_udp_checksum
Definition: dpdk.h:324
struct rte_mbuf ** pkts_enq
Definition: dpdk.h:147
struct rte_ring ** swq
Definition: dpdk.h:146
vlib_buffer_t * buffer_templates
Definition: dpdk.h:360
struct rte_sched_port * hqos
Definition: dpdk.h:149
u64 tx_tail
Definition: dpdk.h:119
u8 *( format_function_t)(u8 *s, va_list *args)
Definition: format.h:48
struct rte_eth_xstat * last_cleared_xstats
Definition: dpdk.h:229
format_function_t format_dpdk_rte_mbuf
Definition: dpdk.h:459
dpdk_device_config_hqos_t hqos
Definition: dpdk.h:313
u16 num_subifs
Definition: dpdk.h:200
struct _vnet_device_class vnet_device_class_t
u8 * pcap_filename
Definition: dpdk.h:371
format_function_t format_dpdk_tx_dma_trace
Definition: dpdk.h:457
struct rte_sched_pipe_params * pipe
Definition: dpdk.h:279
struct rte_mbuf *** tx_vectors
Definition: dpdk.h:172
foreach_dpdk_device_config_item clib_bitmap_t * workers
Definition: dpdk.h:311
PCAP main state data structure.
Definition: pcap.h:124
dpdk_config_main_t dpdk_config_main
Definition: init.c:40
dpdk_portid_t port_id
Definition: dpdk.h:216
vlib_node_registration_t dpdk_input_node
(constructor) VLIB_REGISTER_NODE (dpdk_input_node)
Definition: node.c:619
struct rte_mbuf ** pkts_deq
Definition: dpdk.h:148
dpdk_device_config_t default_devconf
Definition: dpdk.h:341
f64 stat_poll_interval
Definition: dpdk.h:387
u32 pcap_pkts_to_capture
Definition: dpdk.h:373
char i8
Definition: types.h:45
u16 rx_q_used
Definition: dpdk.h:204
unsigned long u64
Definition: types.h:89
format_function_t format_dpdk_rx_rte_mbuf
Definition: dpdk.h:460
clib_error_t * unformat_rss_fn(unformat_input_t *input, uword *rss_fn)
Definition: format.c:757
dpdk_device_hqos_per_worker_thread_t * hqos_wt
Definition: dpdk.h:212
f64 time_last_stats_update
Definition: dpdk.h:230
u32 pcap_sw_if_index
Definition: dpdk.h:372
u32 vlib_sw_if_index
Definition: dpdk.h:166
vlib_pci_addr_t pci_addr
Definition: dpdk.h:301
format_function_t format_dpdk_rx_dma_trace
Definition: dpdk.h:458
dpdk_portid_t bond_port
Definition: dpdk.h:220
u8 ** eal_init_args
Definition: dpdk.h:320
void dpdk_device_stop(dpdk_device_t *xd)
Definition: common.c:172
pcap_main_t pcap_main
Definition: dpdk.h:370
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:62
dpdk_port_type_t port_type
Definition: dpdk.h:231
u16 tx_q_used
Definition: dpdk.h:203
u16 nb_rx_desc
Definition: dpdk.h:205
uint16_t dpdk_portid_t
Definition: dpdk.h:125
u32 hw_if_index
Definition: dpdk.h:165
u32 ** recycle
Definition: dpdk.h:357
dpdk_device_t * devices
Definition: dpdk.h:353
vlib_main_t * vm
Definition: buffer.c:283
u8 nchannels_set_manually
Definition: dpdk.h:329
u16 * cpu_socket_id_by_queue
Definition: dpdk.h:206
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:160
dpdk_device_config_t * dev_confs
Definition: dpdk.h:342
struct rte_mbuf *** rx_vectors
Definition: dpdk.h:173
format_function_t format_dpdk_device_errors
Definition: dpdk.h:456
void dpdk_device_setup(dpdk_device_t *xd)
Definition: common.c:39
u8 coremask_set_manually
Definition: dpdk.h:328
dpdk_pmd_t
Definition: dpdk.h:85
uword admin_up_down_process(vlib_main_t *vm, vlib_node_runtime_t *rt, vlib_frame_t *f)
Definition: device.c:817
format_function_t format_dpdk_device
Definition: dpdk.h:455
int dpdk_port_state_callback(dpdk_portid_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:228
u8 * interface_name_suffix
Definition: dpdk.h:197
format_function_t format_dpdk_device_name
Definition: dpdk.h:454
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:383
u64 tx_head
Definition: dpdk.h:118
u32 poll_sleep_usec
Definition: dpdk.h:390
struct rte_mempool ** pktmbuf_pools
Definition: dpdk.h:398
dpdk_device_hqos_per_hqos_thread_t * hqos_ht
Definition: dpdk.h:213
void dpdk_update_link_state(dpdk_device_t *xd, f64 now)
Definition: init.c:1294
dpdk_portid_t device_index
Definition: dpdk.h:163
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:94
void dpdk_device_start(dpdk_device_t *xd)
Definition: common.c:128
clib_error_t * dpdk_buffer_pool_create(vlib_main_t *vm, unsigned num_mbufs, unsigned socket_id)
Definition: buffer.c:514
unsigned short u16
Definition: types.h:57
vlib_buffer_t buffer
Definition: dpdk.h:423
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
u8 admin_up_down_in_progress
Definition: dpdk.h:379
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:461
u8 no_tx_checksum_offload
Definition: dpdk.h:325
uint32_t * pipe_map
Definition: dpdk.h:280
u32 buffer_flags_template
Definition: dpdk.h:363
u32 vlib_buffer_free_list_index
Definition: dpdk.h:366
int hqos_cpu_first_index
Definition: dpdk.h:382
struct rte_sched_subport_params * subport
Definition: dpdk.h:278
#define foreach_dpdk_device_config_item
Definition: dpdk.h:292
uword clib_bitmap_t
Definition: bitmap.h:50
i8 cpu_socket
Definition: dpdk.h:179
u16 msg_id_base
Definition: dpdk.h:401
u8 * uio_driver_name
Definition: dpdk.h:322
unformat_function_t unformat_dpdk_log_level
Definition: dpdk.h:461
int tx_pcap_enable
Definition: dpdk.h:369
vnet_main_t * vnet_main
Definition: dpdk.h:394
u16 nb_tx_desc
Definition: dpdk.h:194
clib_error_t * unformat_hqos(unformat_input_t *input, dpdk_device_config_hqos_t *hqos)
Definition: format.c:794
u8 vlib_physmem_region_index_t
Definition: physmem.h:43
uword * device_config_index_by_pci_addr
Definition: dpdk.h:343
u8 * buffer_pool_for_queue
Definition: dpdk.h:207
f64 link_state_poll_interval
Definition: dpdk.h:386
dpdk_config_main_t * conf
Definition: dpdk.h:395
vlib_main_t * vlib_main
Definition: dpdk.h:393