1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2017 Intel Corporation
3 */
4
5 #ifndef _TESTPMD_H_
6 #define _TESTPMD_H_
7
8 #include <stdbool.h>
9
10 #include <rte_pci.h>
11 #include <rte_bus_pci.h>
12 #include <rte_gro.h>
13 #include <rte_gso.h>
14 #include <cmdline.h>
15 #include <sys/queue.h>
16
17 #define RTE_PORT_ALL (~(portid_t)0x0)
18
19 #define RTE_TEST_RX_DESC_MAX 2048
20 #define RTE_TEST_TX_DESC_MAX 2048
21
22 #define RTE_PORT_STOPPED (uint16_t)0
23 #define RTE_PORT_STARTED (uint16_t)1
24 #define RTE_PORT_CLOSED (uint16_t)2
25 #define RTE_PORT_HANDLING (uint16_t)3
26
27 /*
28 * It is used to allocate the memory for hash key.
29 * The hash key size is NIC dependent.
30 */
31 #define RSS_HASH_KEY_LENGTH 64
32
33 /*
34 * Default size of the mbuf data buffer to receive standard 1518-byte
35 * Ethernet frames in a mono-segment memory buffer.
36 */
37 #define DEFAULT_MBUF_DATA_SIZE RTE_MBUF_DEFAULT_BUF_SIZE
38 /**< Default size of mbuf data buffer. */
39
40 /*
41 * The maximum number of segments per packet is used when creating
42 * scattered transmit packets composed of a list of mbufs.
43 */
44 #define RTE_MAX_SEGS_PER_PKT 255 /**< nb_segs is a 8-bit unsigned char. */
45
46 /*
47 * The maximum number of segments per packet is used to configure
48 * buffer split feature, also specifies the maximum amount of
49 * optional Rx pools to allocate mbufs to split.
50 */
51 #define MAX_SEGS_BUFFER_SPLIT 8 /**< nb_segs is a 8-bit unsigned char. */
52
53 /* The prefix of the mbuf pool names created by the application. */
54 #define MBUF_POOL_NAME_PFX "mb_pool"
55
56 #define MAX_PKT_BURST 512
57 #define DEF_PKT_BURST 32
58
59 #define DEF_MBUF_CACHE 250
60
61 #define RTE_CACHE_LINE_SIZE_ROUNDUP(size) \
62 (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
63
64 #define NUMA_NO_CONFIG 0xFF
65 #define UMA_NO_CONFIG 0xFF
66
67 typedef uint8_t lcoreid_t;
68 typedef uint16_t portid_t;
69 typedef uint16_t queueid_t;
70 typedef uint16_t streamid_t;
71
72 enum {
73 PORT_TOPOLOGY_PAIRED,
74 PORT_TOPOLOGY_CHAINED,
75 PORT_TOPOLOGY_LOOP,
76 };
77
78 enum {
79 MP_ALLOC_NATIVE, /**< allocate and populate mempool natively */
80 MP_ALLOC_ANON,
81 /**< allocate mempool natively, but populate using anonymous memory */
82 MP_ALLOC_XMEM,
83 /**< allocate and populate mempool using anonymous memory */
84 MP_ALLOC_XMEM_HUGE,
85 /**< allocate and populate mempool using anonymous hugepage memory */
86 MP_ALLOC_XBUF
87 /**< allocate mempool natively, use rte_pktmbuf_pool_create_extbuf */
88 };
89
90 /**
91 * The data structure associated with RX and TX packet burst statistics
92 * that are recorded for each forwarding stream.
93 */
94 struct pkt_burst_stats {
95 unsigned int pkt_burst_spread[MAX_PKT_BURST];
96 };
97
98 /** Information for a given RSS type. */
99 struct rss_type_info {
100 const char *str; /**< Type name. */
101 uint64_t rss_type; /**< Type value. */
102 };
103
104 /**
105 * RSS type information table.
106 *
107 * An entry with a NULL type name terminates the list.
108 */
109 extern const struct rss_type_info rss_type_table[];
110
111 /**
112 * Dynf name array.
113 *
114 * Array that holds the name for each dynf.
115 */
116 extern char dynf_names[64][RTE_MBUF_DYN_NAMESIZE];
117
118 /**
119 * The data structure associated with a forwarding stream between a receive
120 * port/queue and a transmit port/queue.
121 */
122 struct fwd_stream {
123 /* "read-only" data */
124 portid_t rx_port; /**< port to poll for received packets */
125 queueid_t rx_queue; /**< RX queue to poll on "rx_port" */
126 portid_t tx_port; /**< forwarding port of received packets */
127 queueid_t tx_queue; /**< TX queue to send forwarded packets */
128 streamid_t peer_addr; /**< index of peer ethernet address of packets */
129
130 unsigned int retry_enabled;
131
132 /* "read-write" results */
133 uint64_t rx_packets; /**< received packets */
134 uint64_t tx_packets; /**< received packets transmitted */
135 uint64_t fwd_dropped; /**< received packets not forwarded */
136 uint64_t rx_bad_ip_csum ; /**< received packets has bad ip checksum */
137 uint64_t rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
138 uint64_t rx_bad_outer_l4_csum;
139 /**< received packets has bad outer l4 checksum */
140 unsigned int gro_times; /**< GRO operation times */
141 uint64_t core_cycles; /**< used for RX and TX processing */
142 struct pkt_burst_stats rx_burst_stats;
143 struct pkt_burst_stats tx_burst_stats;
144 };
145
146 /**
147 * Age action context types, must be included inside the age action
148 * context structure.
149 */
150 enum age_action_context_type {
151 ACTION_AGE_CONTEXT_TYPE_FLOW,
152 ACTION_AGE_CONTEXT_TYPE_SHARED_ACTION,
153 };
154
155 /** Descriptor for a single flow. */
156 struct port_flow {
157 struct port_flow *next; /**< Next flow in list. */
158 struct port_flow *tmp; /**< Temporary linking. */
159 uint32_t id; /**< Flow rule ID. */
160 struct rte_flow *flow; /**< Opaque flow object returned by PMD. */
161 struct rte_flow_conv_rule rule; /**< Saved flow rule description. */
162 enum age_action_context_type age_type; /**< Age action context type. */
163 uint8_t data[]; /**< Storage for flow rule description */
164 };
165
166 /* Descriptor for shared action */
167 struct port_shared_action {
168 struct port_shared_action *next; /**< Next flow in list. */
169 uint32_t id; /**< Shared action ID. */
170 enum rte_flow_action_type type; /**< Action type. */
171 struct rte_flow_shared_action *action; /**< Shared action handle. */
172 enum age_action_context_type age_type; /**< Age action context type. */
173 };
174
175 struct port_flow_tunnel {
176 LIST_ENTRY(port_flow_tunnel) chain;
177 struct rte_flow_action *pmd_actions;
178 struct rte_flow_item *pmd_items;
179 uint32_t id;
180 uint32_t num_pmd_actions;
181 uint32_t num_pmd_items;
182 struct rte_flow_tunnel tunnel;
183 struct rte_flow_action *actions;
184 struct rte_flow_item *items;
185 };
186
187 struct tunnel_ops {
188 uint32_t id;
189 char type[16];
190 uint32_t enabled:1;
191 uint32_t actions:1;
192 uint32_t items:1;
193 };
194
195 /**
196 * The data structure associated with each port.
197 */
198 struct rte_port {
199 struct rte_eth_dev_info dev_info; /**< PCI info + driver name */
200 struct rte_eth_conf dev_conf; /**< Port configuration. */
201 struct rte_ether_addr eth_addr; /**< Port ethernet address */
202 struct rte_eth_stats stats; /**< Last port statistics */
203 unsigned int socket_id; /**< For NUMA support */
204 uint16_t parse_tunnel:1; /**< Parse internal headers */
205 uint16_t tso_segsz; /**< Segmentation offload MSS for non-tunneled packets. */
206 uint16_t tunnel_tso_segsz; /**< Segmentation offload MSS for tunneled pkts. */
207 uint16_t tx_vlan_id;/**< The tag ID */
208 uint16_t tx_vlan_id_outer;/**< The outer tag ID */
209 uint8_t tx_queue_stats_mapping_enabled;
210 uint8_t rx_queue_stats_mapping_enabled;
211 volatile uint16_t port_status; /**< port started or not */
212 uint8_t need_setup; /**< port just attached */
213 uint8_t need_reconfig; /**< need reconfiguring port or not */
214 uint8_t need_reconfig_queues; /**< need reconfiguring queues or not */
215 uint8_t rss_flag; /**< enable rss or not */
216 uint8_t dcb_flag; /**< enable dcb */
217 uint16_t nb_rx_desc[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue rx desc number */
218 uint16_t nb_tx_desc[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue tx desc number */
219 struct rte_eth_rxconf rx_conf[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue rx configuration */
220 struct rte_eth_txconf tx_conf[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue tx configuration */
221 struct rte_ether_addr *mc_addr_pool; /**< pool of multicast addrs */
222 uint32_t mc_addr_nb; /**< nb. of addr. in mc_addr_pool */
223 uint8_t slave_flag; /**< bonding slave port */
224 struct port_flow *flow_list; /**< Associated flows. */
225 struct port_shared_action *actions_list;
226 /**< Associated shared actions. */
227 LIST_HEAD(, port_flow_tunnel) flow_tunnel_list;
228 const struct rte_eth_rxtx_callback *rx_dump_cb[RTE_MAX_QUEUES_PER_PORT+1];
229 const struct rte_eth_rxtx_callback *tx_dump_cb[RTE_MAX_QUEUES_PER_PORT+1];
230 /**< metadata value to insert in Tx packets. */
231 uint32_t tx_metadata;
232 const struct rte_eth_rxtx_callback *tx_set_md_cb[RTE_MAX_QUEUES_PER_PORT+1];
233 /**< dynamic flags. */
234 uint64_t mbuf_dynf;
235 const struct rte_eth_rxtx_callback *tx_set_dynf_cb[RTE_MAX_QUEUES_PER_PORT+1];
236 };
237
238 /**
239 * The data structure associated with each forwarding logical core.
240 * The logical cores are internally numbered by a core index from 0 to
241 * the maximum number of logical cores - 1.
242 * The system CPU identifier of all logical cores are setup in a global
243 * CPU id. configuration table.
244 */
245 struct fwd_lcore {
246 struct rte_gso_ctx gso_ctx; /**< GSO context */
247 struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
248 void *gro_ctx; /**< GRO context */
249 streamid_t stream_idx; /**< index of 1st stream in "fwd_streams" */
250 streamid_t stream_nb; /**< number of streams in "fwd_streams" */
251 lcoreid_t cpuid_idx; /**< index of logical core in CPU id table */
252 queueid_t tx_queue; /**< TX queue to send forwarded packets */
253 volatile char stopped; /**< stop forwarding when set */
254 };
255
256 /*
257 * Forwarding mode operations:
258 * - IO forwarding mode (default mode)
259 * Forwards packets unchanged.
260 *
261 * - MAC forwarding mode
262 * Set the source and the destination Ethernet addresses of packets
263 * before forwarding them.
264 *
265 * - IEEE1588 forwarding mode
266 * Check that received IEEE1588 Precise Time Protocol (PTP) packets are
267 * filtered and timestamped by the hardware.
268 * Forwards packets unchanged on the same port.
269 * Check that sent IEEE1588 PTP packets are timestamped by the hardware.
270 */
271 typedef void (*port_fwd_begin_t)(portid_t pi);
272 typedef void (*port_fwd_end_t)(portid_t pi);
273 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
274
275 struct fwd_engine {
276 const char *fwd_mode_name; /**< Forwarding mode name. */
277 port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
278 port_fwd_end_t port_fwd_end; /**< NULL if nothing special to do. */
279 packet_fwd_t packet_fwd; /**< Mandatory. */
280 };
281
282 #define BURST_TX_WAIT_US 1
283 #define BURST_TX_RETRIES 64
284
285 extern uint32_t burst_tx_delay_time;
286 extern uint32_t burst_tx_retry_num;
287
288 extern struct fwd_engine io_fwd_engine;
289 extern struct fwd_engine mac_fwd_engine;
290 extern struct fwd_engine mac_swap_engine;
291 extern struct fwd_engine flow_gen_engine;
292 extern struct fwd_engine rx_only_engine;
293 extern struct fwd_engine tx_only_engine;
294 extern struct fwd_engine csum_fwd_engine;
295 extern struct fwd_engine icmp_echo_engine;
296 extern struct fwd_engine noisy_vnf_engine;
297 extern struct fwd_engine five_tuple_swap_fwd_engine;
298 #ifdef RTE_LIBRTE_IEEE1588
299 extern struct fwd_engine ieee1588_fwd_engine;
300 #endif
301
302 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
303 extern cmdline_parse_inst_t cmd_set_raw;
304 extern cmdline_parse_inst_t cmd_show_set_raw;
305 extern cmdline_parse_inst_t cmd_show_set_raw_all;
306
307 extern uint16_t mempool_flags;
308
309 /**
310 * Forwarding Configuration
311 *
312 */
313 struct fwd_config {
314 struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
315 streamid_t nb_fwd_streams; /**< Nb. of forward streams to process. */
316 lcoreid_t nb_fwd_lcores; /**< Nb. of logical cores to launch. */
317 portid_t nb_fwd_ports; /**< Nb. of ports involved. */
318 };
319
320 /**
321 * DCB mode enable
322 */
323 enum dcb_mode_enable
324 {
325 DCB_VT_ENABLED,
326 DCB_ENABLED
327 };
328
329 #define MAX_TX_QUEUE_STATS_MAPPINGS 1024 /* MAX_PORT of 32 @ 32 tx_queues/port */
330 #define MAX_RX_QUEUE_STATS_MAPPINGS 4096 /* MAX_PORT of 32 @ 128 rx_queues/port */
331
332 struct queue_stats_mappings {
333 portid_t port_id;
334 uint16_t queue_id;
335 uint8_t stats_counter_id;
336 } __rte_cache_aligned;
337
338 extern struct queue_stats_mappings tx_queue_stats_mappings_array[];
339 extern struct queue_stats_mappings rx_queue_stats_mappings_array[];
340
341 /* Assign both tx and rx queue stats mappings to the same default values */
342 extern struct queue_stats_mappings *tx_queue_stats_mappings;
343 extern struct queue_stats_mappings *rx_queue_stats_mappings;
344
345 extern uint16_t nb_tx_queue_stats_mappings;
346 extern uint16_t nb_rx_queue_stats_mappings;
347
348 extern uint8_t xstats_hide_zero; /**< Hide zero values for xstats display */
349
350 /* globals used for configuration */
351 extern uint8_t record_core_cycles; /**< Enables measurement of CPU cycles */
352 extern uint8_t record_burst_stats; /**< Enables display of RX and TX bursts */
353 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
354 extern int testpmd_logtype; /**< Log type for testpmd logs */
355 extern uint8_t interactive;
356 extern uint8_t auto_start;
357 extern uint8_t tx_first;
358 extern char cmdline_filename[PATH_MAX]; /**< offline commands file */
359 extern uint8_t numa_support; /**< set by "--numa" parameter */
360 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
361 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
362 extern uint8_t flow_isolate_all; /**< set by "--flow-isolate-all */
363 extern uint8_t mp_alloc_type;
364 /**< set by "--mp-anon" or "--mp-alloc" parameter */
365 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
366 extern uint8_t no_device_start; /**<set by "--disable-device-start" parameter */
367 extern volatile int test_done; /* stop packet forwarding when set to 1. */
368 extern uint8_t lsc_interrupt; /**< disabled by "--no-lsc-interrupt" parameter */
369 extern uint8_t rmv_interrupt; /**< disabled by "--no-rmv-interrupt" parameter */
370 extern uint32_t event_print_mask;
371 /**< set by "--print-event xxxx" and "--mask-event xxxx parameters */
372 extern bool setup_on_probe_event; /**< disabled by port setup-on iterator */
373 extern uint8_t hot_plug; /**< enable by "--hot-plug" parameter */
374 extern int do_mlockall; /**< set by "--mlockall" or "--no-mlockall" parameter */
375 extern uint8_t clear_ptypes; /**< disabled by set ptype cmd */
376
377 #ifdef RTE_LIBRTE_IXGBE_BYPASS
378 extern uint32_t bypass_timeout; /**< Store the NIC bypass watchdog timeout */
379 #endif
380
381 /*
382 * Store specified sockets on which memory pool to be used by ports
383 * is allocated.
384 */
385 extern uint8_t port_numa[RTE_MAX_ETHPORTS];
386
387 /*
388 * Store specified sockets on which RX ring to be used by ports
389 * is allocated.
390 */
391 extern uint8_t rxring_numa[RTE_MAX_ETHPORTS];
392
393 /*
394 * Store specified sockets on which TX ring to be used by ports
395 * is allocated.
396 */
397 extern uint8_t txring_numa[RTE_MAX_ETHPORTS];
398
399 extern uint8_t socket_num;
400
401 /*
402 * Configuration of logical cores:
403 * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
404 */
405 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
406 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
407 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
408 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
409 extern unsigned int num_sockets;
410 extern unsigned int socket_ids[RTE_MAX_NUMA_NODES];
411
412 /*
413 * Configuration of Ethernet ports:
414 * nb_fwd_ports <= nb_cfg_ports <= nb_ports
415 */
416 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
417 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
418 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
419 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
420 extern struct rte_port *ports;
421
422 extern struct rte_eth_rxmode rx_mode;
423 extern struct rte_eth_txmode tx_mode;
424
425 extern uint64_t rss_hf;
426
427 extern queueid_t nb_hairpinq;
428 extern queueid_t nb_rxq;
429 extern queueid_t nb_txq;
430
431 extern uint16_t nb_rxd;
432 extern uint16_t nb_txd;
433
434 extern int16_t rx_free_thresh;
435 extern int8_t rx_drop_en;
436 extern int16_t tx_free_thresh;
437 extern int16_t tx_rs_thresh;
438
439 extern uint16_t noisy_tx_sw_bufsz;
440 extern uint16_t noisy_tx_sw_buf_flush_time;
441 extern uint64_t noisy_lkup_mem_sz;
442 extern uint64_t noisy_lkup_num_writes;
443 extern uint64_t noisy_lkup_num_reads;
444 extern uint64_t noisy_lkup_num_reads_writes;
445
446 extern uint8_t dcb_config;
447 extern uint8_t dcb_test;
448
449 extern uint32_t mbuf_data_size_n;
450 extern uint16_t mbuf_data_size[MAX_SEGS_BUFFER_SPLIT];
451 /**< Mbuf data space size. */
452 extern uint32_t param_total_num_mbufs;
453
454 extern uint16_t stats_period;
455
456 extern uint16_t hairpin_mode;
457
458 #ifdef RTE_LIB_LATENCYSTATS
459 extern uint8_t latencystats_enabled;
460 extern lcoreid_t latencystats_lcore_id;
461 #endif
462
463 #ifdef RTE_LIB_BITRATESTATS
464 extern lcoreid_t bitrate_lcore_id;
465 extern uint8_t bitrate_enabled;
466 #endif
467
468 extern struct rte_fdir_conf fdir_conf;
469
470 /*
471 * Configuration of packet segments used to scatter received packets
472 * if some of split features is configured.
473 */
474 extern uint16_t rx_pkt_seg_lengths[MAX_SEGS_BUFFER_SPLIT];
475 extern uint8_t rx_pkt_nb_segs; /**< Number of segments to split */
476 extern uint16_t rx_pkt_seg_offsets[MAX_SEGS_BUFFER_SPLIT];
477 extern uint8_t rx_pkt_nb_offs; /**< Number of specified offsets */
478
479 /*
480 * Configuration of packet segments used by the "txonly" processing engine.
481 */
482 #define TXONLY_DEF_PACKET_LEN 64
483 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
484 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
485 extern uint8_t tx_pkt_nb_segs; /**< Number of segments in TX packets */
486 extern uint32_t tx_pkt_times_intra;
487 extern uint32_t tx_pkt_times_inter;
488
489 enum tx_pkt_split {
490 TX_PKT_SPLIT_OFF,
491 TX_PKT_SPLIT_ON,
492 TX_PKT_SPLIT_RND,
493 };
494
495 extern enum tx_pkt_split tx_pkt_split;
496
497 extern uint8_t txonly_multi_flow;
498
499 extern uint16_t nb_pkt_per_burst;
500 extern uint16_t mb_mempool_cache;
501 extern int8_t rx_pthresh;
502 extern int8_t rx_hthresh;
503 extern int8_t rx_wthresh;
504 extern int8_t tx_pthresh;
505 extern int8_t tx_hthresh;
506 extern int8_t tx_wthresh;
507
508 extern uint16_t tx_udp_src_port;
509 extern uint16_t tx_udp_dst_port;
510
511 extern uint32_t tx_ip_src_addr;
512 extern uint32_t tx_ip_dst_addr;
513
514 extern struct fwd_config cur_fwd_config;
515 extern struct fwd_engine *cur_fwd_eng;
516 extern uint32_t retry_enabled;
517 extern struct fwd_lcore **fwd_lcores;
518 extern struct fwd_stream **fwd_streams;
519
520 extern uint16_t vxlan_gpe_udp_port; /**< UDP port of tunnel VXLAN-GPE. */
521 extern uint16_t geneve_udp_port; /**< UDP port of tunnel GENEVE. */
522
523 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
524 extern struct rte_ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
525
526 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
527 extern uint32_t burst_tx_retry_num; /**< Burst tx retry number for mac-retry. */
528
529 #define GRO_DEFAULT_ITEM_NUM_PER_FLOW 32
530 #define GRO_DEFAULT_FLOW_NUM (RTE_GRO_MAX_BURST_ITEM_NUM / \
531 GRO_DEFAULT_ITEM_NUM_PER_FLOW)
532
533 #define GRO_DEFAULT_FLUSH_CYCLES 1
534 #define GRO_MAX_FLUSH_CYCLES 4
535
536 struct gro_status {
537 struct rte_gro_param param;
538 uint8_t enable;
539 };
540 extern struct gro_status gro_ports[RTE_MAX_ETHPORTS];
541 extern uint8_t gro_flush_cycles;
542
543 #define GSO_MAX_PKT_BURST 2048
544 struct gso_status {
545 uint8_t enable;
546 };
547 extern struct gso_status gso_ports[RTE_MAX_ETHPORTS];
548 extern uint16_t gso_max_segment_size;
549
550 /* VXLAN encap/decap parameters. */
551 struct vxlan_encap_conf {
552 uint32_t select_ipv4:1;
553 uint32_t select_vlan:1;
554 uint32_t select_tos_ttl:1;
555 uint8_t vni[3];
556 rte_be16_t udp_src;
557 rte_be16_t udp_dst;
558 rte_be32_t ipv4_src;
559 rte_be32_t ipv4_dst;
560 uint8_t ipv6_src[16];
561 uint8_t ipv6_dst[16];
562 rte_be16_t vlan_tci;
563 uint8_t ip_tos;
564 uint8_t ip_ttl;
565 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
566 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
567 };
568
569 extern struct vxlan_encap_conf vxlan_encap_conf;
570
571 /* NVGRE encap/decap parameters. */
572 struct nvgre_encap_conf {
573 uint32_t select_ipv4:1;
574 uint32_t select_vlan:1;
575 uint8_t tni[3];
576 rte_be32_t ipv4_src;
577 rte_be32_t ipv4_dst;
578 uint8_t ipv6_src[16];
579 uint8_t ipv6_dst[16];
580 rte_be16_t vlan_tci;
581 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
582 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
583 };
584
585 extern struct nvgre_encap_conf nvgre_encap_conf;
586
587 /* L2 encap parameters. */
588 struct l2_encap_conf {
589 uint32_t select_ipv4:1;
590 uint32_t select_vlan:1;
591 rte_be16_t vlan_tci;
592 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
593 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
594 };
595 extern struct l2_encap_conf l2_encap_conf;
596
597 /* L2 decap parameters. */
598 struct l2_decap_conf {
599 uint32_t select_vlan:1;
600 };
601 extern struct l2_decap_conf l2_decap_conf;
602
603 /* MPLSoGRE encap parameters. */
604 struct mplsogre_encap_conf {
605 uint32_t select_ipv4:1;
606 uint32_t select_vlan:1;
607 uint8_t label[3];
608 rte_be32_t ipv4_src;
609 rte_be32_t ipv4_dst;
610 uint8_t ipv6_src[16];
611 uint8_t ipv6_dst[16];
612 rte_be16_t vlan_tci;
613 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
614 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
615 };
616 extern struct mplsogre_encap_conf mplsogre_encap_conf;
617
618 /* MPLSoGRE decap parameters. */
619 struct mplsogre_decap_conf {
620 uint32_t select_ipv4:1;
621 uint32_t select_vlan:1;
622 };
623 extern struct mplsogre_decap_conf mplsogre_decap_conf;
624
625 /* MPLSoUDP encap parameters. */
626 struct mplsoudp_encap_conf {
627 uint32_t select_ipv4:1;
628 uint32_t select_vlan:1;
629 uint8_t label[3];
630 rte_be16_t udp_src;
631 rte_be16_t udp_dst;
632 rte_be32_t ipv4_src;
633 rte_be32_t ipv4_dst;
634 uint8_t ipv6_src[16];
635 uint8_t ipv6_dst[16];
636 rte_be16_t vlan_tci;
637 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
638 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
639 };
640 extern struct mplsoudp_encap_conf mplsoudp_encap_conf;
641
642 /* MPLSoUDP decap parameters. */
643 struct mplsoudp_decap_conf {
644 uint32_t select_ipv4:1;
645 uint32_t select_vlan:1;
646 };
647 extern struct mplsoudp_decap_conf mplsoudp_decap_conf;
648
649 extern enum rte_eth_rx_mq_mode rx_mq_mode;
650
651 static inline unsigned int
lcore_num(void)652 lcore_num(void)
653 {
654 unsigned int i;
655
656 for (i = 0; i < RTE_MAX_LCORE; ++i)
657 if (fwd_lcores_cpuids[i] == rte_lcore_id())
658 return i;
659
660 rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
661 }
662
663 void
664 parse_fwd_portlist(const char *port);
665
666 static inline struct fwd_lcore *
current_fwd_lcore(void)667 current_fwd_lcore(void)
668 {
669 return fwd_lcores[lcore_num()];
670 }
671
672 /* Mbuf Pools */
673 static inline void
mbuf_poolname_build(unsigned int sock_id,char * mp_name,int name_size,uint16_t idx)674 mbuf_poolname_build(unsigned int sock_id, char *mp_name,
675 int name_size, uint16_t idx)
676 {
677 if (!idx)
678 snprintf(mp_name, name_size,
679 MBUF_POOL_NAME_PFX "_%u", sock_id);
680 else
681 snprintf(mp_name, name_size,
682 MBUF_POOL_NAME_PFX "_%hu_%hu", (uint16_t)sock_id, idx);
683 }
684
685 static inline struct rte_mempool *
mbuf_pool_find(unsigned int sock_id,uint16_t idx)686 mbuf_pool_find(unsigned int sock_id, uint16_t idx)
687 {
688 char pool_name[RTE_MEMPOOL_NAMESIZE];
689
690 mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name), idx);
691 return rte_mempool_lookup((const char *)pool_name);
692 }
693
694 /**
695 * Read/Write operations on a PCI register of a port.
696 */
697 static inline uint32_t
port_pci_reg_read(struct rte_port * port,uint32_t reg_off)698 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
699 {
700 const struct rte_pci_device *pci_dev;
701 const struct rte_bus *bus;
702 void *reg_addr;
703 uint32_t reg_v;
704
705 if (!port->dev_info.device) {
706 printf("Invalid device\n");
707 return 0;
708 }
709
710 bus = rte_bus_find_by_device(port->dev_info.device);
711 if (bus && !strcmp(bus->name, "pci")) {
712 pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
713 } else {
714 printf("Not a PCI device\n");
715 return 0;
716 }
717
718 reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
719 reg_v = *((volatile uint32_t *)reg_addr);
720 return rte_le_to_cpu_32(reg_v);
721 }
722
723 #define port_id_pci_reg_read(pt_id, reg_off) \
724 port_pci_reg_read(&ports[(pt_id)], (reg_off))
725
726 static inline void
port_pci_reg_write(struct rte_port * port,uint32_t reg_off,uint32_t reg_v)727 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
728 {
729 const struct rte_pci_device *pci_dev;
730 const struct rte_bus *bus;
731 void *reg_addr;
732
733 if (!port->dev_info.device) {
734 printf("Invalid device\n");
735 return;
736 }
737
738 bus = rte_bus_find_by_device(port->dev_info.device);
739 if (bus && !strcmp(bus->name, "pci")) {
740 pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
741 } else {
742 printf("Not a PCI device\n");
743 return;
744 }
745
746 reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
747 *((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
748 }
749
750 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
751 port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
752
753 static inline void
get_start_cycles(uint64_t * start_tsc)754 get_start_cycles(uint64_t *start_tsc)
755 {
756 if (record_core_cycles)
757 *start_tsc = rte_rdtsc();
758 }
759
760 static inline void
get_end_cycles(struct fwd_stream * fs,uint64_t start_tsc)761 get_end_cycles(struct fwd_stream *fs, uint64_t start_tsc)
762 {
763 if (record_core_cycles)
764 fs->core_cycles += rte_rdtsc() - start_tsc;
765 }
766
767 static inline void
inc_rx_burst_stats(struct fwd_stream * fs,uint16_t nb_rx)768 inc_rx_burst_stats(struct fwd_stream *fs, uint16_t nb_rx)
769 {
770 if (record_burst_stats)
771 fs->rx_burst_stats.pkt_burst_spread[nb_rx]++;
772 }
773
774 static inline void
inc_tx_burst_stats(struct fwd_stream * fs,uint16_t nb_tx)775 inc_tx_burst_stats(struct fwd_stream *fs, uint16_t nb_tx)
776 {
777 if (record_burst_stats)
778 fs->tx_burst_stats.pkt_burst_spread[nb_tx]++;
779 }
780
781 /* Prototypes */
782 unsigned int parse_item_list(char* str, const char* item_name,
783 unsigned int max_items,
784 unsigned int *parsed_items, int check_unique_values);
785 void launch_args_parse(int argc, char** argv);
786 void cmdline_read_from_file(const char *filename);
787 void prompt(void);
788 void prompt_exit(void);
789 void nic_stats_display(portid_t port_id);
790 void nic_stats_clear(portid_t port_id);
791 void nic_xstats_display(portid_t port_id);
792 void nic_xstats_clear(portid_t port_id);
793 void nic_stats_mapping_display(portid_t port_id);
794 void device_infos_display(const char *identifier);
795 void port_infos_display(portid_t port_id);
796 void port_summary_display(portid_t port_id);
797 void port_eeprom_display(portid_t port_id);
798 void port_module_eeprom_display(portid_t port_id);
799 void port_summary_header_display(void);
800 void port_offload_cap_display(portid_t port_id);
801 void rx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
802 void tx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
803 void fwd_lcores_config_display(void);
804 void pkt_fwd_config_display(struct fwd_config *cfg);
805 void rxtx_config_display(void);
806 void fwd_config_setup(void);
807 void set_def_fwd_config(void);
808 void reconfig(portid_t new_port_id, unsigned socket_id);
809 int init_fwd_streams(void);
810 void update_fwd_ports(portid_t new_pid);
811
812 void set_fwd_eth_peer(portid_t port_id, char *peer_addr);
813
814 void port_mtu_set(portid_t port_id, uint16_t mtu);
815 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
816 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
817 uint8_t bit_v);
818 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
819 uint8_t bit1_pos, uint8_t bit2_pos);
820 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
821 uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
822 void port_reg_display(portid_t port_id, uint32_t reg_off);
823 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
824 int port_shared_action_create(portid_t port_id, uint32_t id,
825 const struct rte_flow_shared_action_conf *conf,
826 const struct rte_flow_action *action);
827 int port_shared_action_destroy(portid_t port_id,
828 uint32_t n, const uint32_t *action);
829 struct rte_flow_shared_action *port_shared_action_get_by_id(portid_t port_id,
830 uint32_t id);
831 int port_shared_action_update(portid_t port_id, uint32_t id,
832 const struct rte_flow_action *action);
833 int port_flow_validate(portid_t port_id,
834 const struct rte_flow_attr *attr,
835 const struct rte_flow_item *pattern,
836 const struct rte_flow_action *actions,
837 const struct tunnel_ops *tunnel_ops);
838 int port_flow_create(portid_t port_id,
839 const struct rte_flow_attr *attr,
840 const struct rte_flow_item *pattern,
841 const struct rte_flow_action *actions,
842 const struct tunnel_ops *tunnel_ops);
843 int port_shared_action_query(portid_t port_id, uint32_t id);
844 void update_age_action_context(const struct rte_flow_action *actions,
845 struct port_flow *pf);
846 int port_flow_destroy(portid_t port_id, uint32_t n, const uint32_t *rule);
847 int port_flow_flush(portid_t port_id);
848 int port_flow_dump(portid_t port_id, const char *file_name);
849 int port_flow_query(portid_t port_id, uint32_t rule,
850 const struct rte_flow_action *action);
851 void port_flow_list(portid_t port_id, uint32_t n, const uint32_t *group);
852 void port_flow_aged(portid_t port_id, uint8_t destroy);
853 const char *port_flow_tunnel_type(struct rte_flow_tunnel *tunnel);
854 struct port_flow_tunnel *
855 port_flow_locate_tunnel(uint16_t port_id, struct rte_flow_tunnel *tun);
856 void port_flow_tunnel_list(portid_t port_id);
857 void port_flow_tunnel_destroy(portid_t port_id, uint32_t tunnel_id);
858 void port_flow_tunnel_create(portid_t port_id, const struct tunnel_ops *ops);
859 int port_flow_isolate(portid_t port_id, int set);
860
861 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
862 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
863
864 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
865 int set_fwd_lcores_mask(uint64_t lcoremask);
866 void set_fwd_lcores_number(uint16_t nb_lc);
867
868 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
869 void set_fwd_ports_mask(uint64_t portmask);
870 void set_fwd_ports_number(uint16_t nb_pt);
871 int port_is_forwarding(portid_t port_id);
872
873 void rx_vlan_strip_set(portid_t port_id, int on);
874 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
875
876 void rx_vlan_filter_set(portid_t port_id, int on);
877 void rx_vlan_all_filter_set(portid_t port_id, int on);
878 void rx_vlan_qinq_strip_set(portid_t port_id, int on);
879 int rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
880 void vlan_extend_set(portid_t port_id, int on);
881 void vlan_tpid_set(portid_t port_id, enum rte_vlan_type vlan_type,
882 uint16_t tp_id);
883 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
884 void tx_qinq_set(portid_t port_id, uint16_t vlan_id, uint16_t vlan_id_outer);
885 void tx_vlan_reset(portid_t port_id);
886 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
887
888 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
889
890 void set_xstats_hide_zero(uint8_t on_off);
891
892 void set_record_core_cycles(uint8_t on_off);
893 void set_record_burst_stats(uint8_t on_off);
894 void set_verbose_level(uint16_t vb_level);
895 void set_rx_pkt_segments(unsigned int *seg_lengths, unsigned int nb_segs);
896 void show_rx_pkt_segments(void);
897 void set_rx_pkt_offsets(unsigned int *seg_offsets, unsigned int nb_offs);
898 void show_rx_pkt_offsets(void);
899 void set_tx_pkt_segments(unsigned int *seg_lengths, unsigned int nb_segs);
900 void show_tx_pkt_segments(void);
901 void set_tx_pkt_times(unsigned int *tx_times);
902 void show_tx_pkt_times(void);
903 void set_tx_pkt_split(const char *name);
904 int parse_fec_mode(const char *name, enum rte_eth_fec_mode *mode);
905 void show_fec_capability(uint32_t num, struct rte_eth_fec_capa *speed_fec_capa);
906 void set_nb_pkt_per_burst(uint16_t pkt_burst);
907 char *list_pkt_forwarding_modes(void);
908 char *list_pkt_forwarding_retry_modes(void);
909 void set_pkt_forwarding_mode(const char *fwd_mode);
910 void start_packet_forwarding(int with_tx_first);
911 void fwd_stats_display(void);
912 void fwd_stats_reset(void);
913 void stop_packet_forwarding(void);
914 void dev_set_link_up(portid_t pid);
915 void dev_set_link_down(portid_t pid);
916 void init_port_config(void);
917 void set_port_slave_flag(portid_t slave_pid);
918 void clear_port_slave_flag(portid_t slave_pid);
919 uint8_t port_is_bonding_slave(portid_t slave_pid);
920
921 int init_port_dcb_config(portid_t pid, enum dcb_mode_enable dcb_mode,
922 enum rte_eth_nb_tcs num_tcs,
923 uint8_t pfc_en);
924 int start_port(portid_t pid);
925 void stop_port(portid_t pid);
926 void close_port(portid_t pid);
927 void reset_port(portid_t pid);
928 void attach_port(char *identifier);
929 void detach_devargs(char *identifier);
930 void detach_port_device(portid_t port_id);
931 int all_ports_stopped(void);
932 int port_is_stopped(portid_t port_id);
933 int port_is_started(portid_t port_id);
934 void pmd_test_exit(void);
935 #if defined(RTE_NET_I40E) || defined(RTE_NET_IXGBE)
936 void fdir_get_infos(portid_t port_id);
937 #endif
938 void fdir_set_flex_mask(portid_t port_id,
939 struct rte_eth_fdir_flex_mask *cfg);
940 void fdir_set_flex_payload(portid_t port_id,
941 struct rte_eth_flex_payload_cfg *cfg);
942 void port_rss_reta_info(portid_t port_id,
943 struct rte_eth_rss_reta_entry64 *reta_conf,
944 uint16_t nb_entries);
945
946 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
947
948 int
949 rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
950 uint16_t nb_rx_desc, unsigned int socket_id,
951 struct rte_eth_rxconf *rx_conf, struct rte_mempool *mp);
952
953 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
954 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
955 uint64_t q_msk);
956
957 void port_rss_hash_conf_show(portid_t port_id, int show_rss_key);
958 void port_rss_hash_key_update(portid_t port_id, char rss_type[],
959 uint8_t *hash_key, uint hash_key_len);
960 int rx_queue_id_is_invalid(queueid_t rxq_id);
961 int tx_queue_id_is_invalid(queueid_t txq_id);
962 void setup_gro(const char *onoff, portid_t port_id);
963 void setup_gro_flush_cycles(uint8_t cycles);
964 void show_gro(portid_t port_id);
965 void setup_gso(const char *mode, portid_t port_id);
966 int eth_dev_info_get_print_err(uint16_t port_id,
967 struct rte_eth_dev_info *dev_info);
968 void eth_set_promisc_mode(uint16_t port_id, int enable);
969 void eth_set_allmulticast_mode(uint16_t port, int enable);
970 int eth_link_get_nowait_print_err(uint16_t port_id, struct rte_eth_link *link);
971 int eth_macaddr_get_print_err(uint16_t port_id,
972 struct rte_ether_addr *mac_addr);
973
974 /* Functions to display the set of MAC addresses added to a port*/
975 void show_macs(portid_t port_id);
976 void show_mcast_macs(portid_t port_id);
977
978 /* Functions to manage the set of filtered Multicast MAC addresses */
979 void mcast_addr_add(portid_t port_id, struct rte_ether_addr *mc_addr);
980 void mcast_addr_remove(portid_t port_id, struct rte_ether_addr *mc_addr);
981 void port_dcb_info_display(portid_t port_id);
982
983 uint8_t *open_file(const char *file_path, uint32_t *size);
984 int save_file(const char *file_path, uint8_t *buf, uint32_t size);
985 int close_file(uint8_t *buf);
986
987 void port_queue_region_info_display(portid_t port_id, void *buf);
988
989 enum print_warning {
990 ENABLED_WARN = 0,
991 DISABLED_WARN
992 };
993 int port_id_is_invalid(portid_t port_id, enum print_warning warning);
994 void print_valid_ports(void);
995 int new_socket_id(unsigned int socket_id);
996
997 queueid_t get_allowed_max_nb_rxq(portid_t *pid);
998 int check_nb_rxq(queueid_t rxq);
999 queueid_t get_allowed_max_nb_txq(portid_t *pid);
1000 int check_nb_txq(queueid_t txq);
1001 int check_nb_rxd(queueid_t rxd);
1002 int check_nb_txd(queueid_t txd);
1003 queueid_t get_allowed_max_nb_hairpinq(portid_t *pid);
1004 int check_nb_hairpinq(queueid_t hairpinq);
1005
1006 uint16_t dump_rx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
1007 uint16_t nb_pkts, __rte_unused uint16_t max_pkts,
1008 __rte_unused void *user_param);
1009
1010 uint16_t dump_tx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
1011 uint16_t nb_pkts, __rte_unused void *user_param);
1012
1013 void add_rx_dump_callbacks(portid_t portid);
1014 void remove_rx_dump_callbacks(portid_t portid);
1015 void add_tx_dump_callbacks(portid_t portid);
1016 void remove_tx_dump_callbacks(portid_t portid);
1017 void configure_rxtx_dump_callbacks(uint16_t verbose);
1018
1019 uint16_t tx_pkt_set_md(uint16_t port_id, __rte_unused uint16_t queue,
1020 struct rte_mbuf *pkts[], uint16_t nb_pkts,
1021 __rte_unused void *user_param);
1022 void add_tx_md_callback(portid_t portid);
1023 void remove_tx_md_callback(portid_t portid);
1024
1025 uint16_t tx_pkt_set_dynf(uint16_t port_id, __rte_unused uint16_t queue,
1026 struct rte_mbuf *pkts[], uint16_t nb_pkts,
1027 __rte_unused void *user_param);
1028 void add_tx_dynf_callback(portid_t portid);
1029 void remove_tx_dynf_callback(portid_t portid);
1030
1031 /*
1032 * Work-around of a compilation error with ICC on invocations of the
1033 * rte_be_to_cpu_16() function.
1034 */
1035 #ifdef __GCC__
1036 #define RTE_BE_TO_CPU_16(be_16_v) rte_be_to_cpu_16((be_16_v))
1037 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
1038 #else
1039 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
1040 #define RTE_BE_TO_CPU_16(be_16_v) (be_16_v)
1041 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
1042 #else
1043 #define RTE_BE_TO_CPU_16(be_16_v) \
1044 (uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
1045 #define RTE_CPU_TO_BE_16(cpu_16_v) \
1046 (uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
1047 #endif
1048 #endif /* __GCC__ */
1049
1050 #define TESTPMD_LOG(level, fmt, args...) \
1051 rte_log(RTE_LOG_ ## level, testpmd_logtype, "testpmd: " fmt, ## args)
1052
1053 #endif /* _TESTPMD_H_ */
1054