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