xref: /dpdk/app/test-pmd/testpmd.h (revision bb44fb6fe7713ddcd023d5b9bacadf074d68092e)
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 <rte_pci.h>
9 #include <rte_bus_pci.h>
10 #include <rte_gro.h>
11 #include <rte_gso.h>
12 
13 #define RTE_PORT_ALL            (~(portid_t)0x0)
14 
15 #define RTE_TEST_RX_DESC_MAX    2048
16 #define RTE_TEST_TX_DESC_MAX    2048
17 
18 #define RTE_PORT_STOPPED        (uint16_t)0
19 #define RTE_PORT_STARTED        (uint16_t)1
20 #define RTE_PORT_CLOSED         (uint16_t)2
21 #define RTE_PORT_HANDLING       (uint16_t)3
22 
23 /*
24  * It is used to allocate the memory for hash key.
25  * The hash key size is NIC dependent.
26  */
27 #define RSS_HASH_KEY_LENGTH 64
28 
29 /*
30  * Default size of the mbuf data buffer to receive standard 1518-byte
31  * Ethernet frames in a mono-segment memory buffer.
32  */
33 #define DEFAULT_MBUF_DATA_SIZE RTE_MBUF_DEFAULT_BUF_SIZE
34 /**< Default size of mbuf data buffer. */
35 
36 /*
37  * The maximum number of segments per packet is used when creating
38  * scattered transmit packets composed of a list of mbufs.
39  */
40 #define RTE_MAX_SEGS_PER_PKT 255 /**< nb_segs is a 8-bit unsigned char. */
41 
42 #define MAX_PKT_BURST 512
43 #define DEF_PKT_BURST 32
44 
45 #define DEF_MBUF_CACHE 250
46 
47 #define RTE_CACHE_LINE_SIZE_ROUNDUP(size) \
48 	(RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
49 
50 #define NUMA_NO_CONFIG 0xFF
51 #define UMA_NO_CONFIG  0xFF
52 
53 typedef uint8_t  lcoreid_t;
54 typedef uint16_t portid_t;
55 typedef uint16_t queueid_t;
56 typedef uint16_t streamid_t;
57 
58 #define MAX_QUEUE_ID ((1 << (sizeof(queueid_t) * 8)) - 1)
59 
60 #if defined RTE_LIBRTE_PMD_SOFTNIC
61 #define SOFTNIC			1
62 #else
63 #define SOFTNIC			0
64 #endif
65 
66 enum {
67 	PORT_TOPOLOGY_PAIRED,
68 	PORT_TOPOLOGY_CHAINED,
69 	PORT_TOPOLOGY_LOOP,
70 };
71 
72 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
73 /**
74  * The data structure associated with RX and TX packet burst statistics
75  * that are recorded for each forwarding stream.
76  */
77 struct pkt_burst_stats {
78 	unsigned int pkt_burst_spread[MAX_PKT_BURST];
79 };
80 #endif
81 
82 /** Information for a given RSS type. */
83 struct rss_type_info {
84 	const char *str; /**< Type name. */
85 	uint64_t rss_type; /**< Type value. */
86 };
87 
88 /**
89  * RSS type information table.
90  *
91  * An entry with a NULL type name terminates the list.
92  */
93 extern const struct rss_type_info rss_type_table[];
94 
95 /**
96  * The data structure associated with a forwarding stream between a receive
97  * port/queue and a transmit port/queue.
98  */
99 struct fwd_stream {
100 	/* "read-only" data */
101 	portid_t   rx_port;   /**< port to poll for received packets */
102 	queueid_t  rx_queue;  /**< RX queue to poll on "rx_port" */
103 	portid_t   tx_port;   /**< forwarding port of received packets */
104 	queueid_t  tx_queue;  /**< TX queue to send forwarded packets */
105 	streamid_t peer_addr; /**< index of peer ethernet address of packets */
106 
107 	unsigned int retry_enabled;
108 
109 	/* "read-write" results */
110 	unsigned int rx_packets;  /**< received packets */
111 	unsigned int tx_packets;  /**< received packets transmitted */
112 	unsigned int fwd_dropped; /**< received packets not forwarded */
113 	unsigned int rx_bad_ip_csum ; /**< received packets has bad ip checksum */
114 	unsigned int rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
115 	unsigned int gro_times;	/**< GRO operation times */
116 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
117 	uint64_t     core_cycles; /**< used for RX and TX processing */
118 #endif
119 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
120 	struct pkt_burst_stats rx_burst_stats;
121 	struct pkt_burst_stats tx_burst_stats;
122 #endif
123 };
124 
125 /** Descriptor for a single flow. */
126 struct port_flow {
127 	size_t size; /**< Allocated space including data[]. */
128 	struct port_flow *next; /**< Next flow in list. */
129 	struct port_flow *tmp; /**< Temporary linking. */
130 	uint32_t id; /**< Flow rule ID. */
131 	struct rte_flow *flow; /**< Opaque flow object returned by PMD. */
132 	struct rte_flow_attr attr; /**< Attributes. */
133 	struct rte_flow_item *pattern; /**< Pattern. */
134 	struct rte_flow_action *actions; /**< Actions. */
135 	uint8_t data[]; /**< Storage for pattern/actions. */
136 };
137 
138 #ifdef SOFTNIC
139 /**
140  * The data structure associate with softnic port
141  */
142 struct softnic_port {
143 	uint32_t default_tm_hierarchy_enable; /**< default tm hierarchy */
144 	struct fwd_lcore **fwd_lcore_arg; /**< softnic fwd core parameters */
145 };
146 #endif
147 
148 /**
149  * The data structure associated with each port.
150  */
151 struct rte_port {
152 	struct rte_eth_dev_info dev_info;   /**< PCI info + driver name */
153 	struct rte_eth_conf     dev_conf;   /**< Port configuration. */
154 	struct ether_addr       eth_addr;   /**< Port ethernet address */
155 	struct rte_eth_stats    stats;      /**< Last port statistics */
156 	uint64_t                tx_dropped; /**< If no descriptor in TX ring */
157 	struct fwd_stream       *rx_stream; /**< Port RX stream, if unique */
158 	struct fwd_stream       *tx_stream; /**< Port TX stream, if unique */
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 	void                    *fwd_ctx;   /**< Forwarding mode context */
166 	uint64_t                rx_bad_ip_csum; /**< rx pkts with bad ip checksum  */
167 	uint64_t                rx_bad_l4_csum; /**< rx pkts with bad l4 checksum */
168 	uint8_t                 tx_queue_stats_mapping_enabled;
169 	uint8_t                 rx_queue_stats_mapping_enabled;
170 	volatile uint16_t        port_status;    /**< port started or not */
171 	uint8_t                 need_reconfig;  /**< need reconfiguring port or not */
172 	uint8_t                 need_reconfig_queues; /**< need reconfiguring queues or not */
173 	uint8_t                 rss_flag;   /**< enable rss or not */
174 	uint8_t                 dcb_flag;   /**< enable dcb */
175 	uint16_t                nb_rx_desc[MAX_QUEUE_ID+1]; /**< per queue rx desc number */
176 	uint16_t                nb_tx_desc[MAX_QUEUE_ID+1]; /**< per queue tx desc number */
177 	struct rte_eth_rxconf   rx_conf[MAX_QUEUE_ID+1]; /**< per queue rx configuration */
178 	struct rte_eth_txconf   tx_conf[MAX_QUEUE_ID+1]; /**< per queue tx configuration */
179 	struct ether_addr       *mc_addr_pool; /**< pool of multicast addrs */
180 	uint32_t                mc_addr_nb; /**< nb. of addr. in mc_addr_pool */
181 	uint8_t                 slave_flag; /**< bonding slave port */
182 	struct port_flow        *flow_list; /**< Associated flows. */
183 #ifdef SOFTNIC
184 	struct softnic_port     softport;  /**< softnic params */
185 #endif
186 };
187 
188 /**
189  * The data structure associated with each forwarding logical core.
190  * The logical cores are internally numbered by a core index from 0 to
191  * the maximum number of logical cores - 1.
192  * The system CPU identifier of all logical cores are setup in a global
193  * CPU id. configuration table.
194  */
195 struct fwd_lcore {
196 	struct rte_gso_ctx gso_ctx;     /**< GSO context */
197 	struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
198 	void *gro_ctx;		/**< GRO context */
199 	streamid_t stream_idx;   /**< index of 1st stream in "fwd_streams" */
200 	streamid_t stream_nb;    /**< number of streams in "fwd_streams" */
201 	lcoreid_t  cpuid_idx;    /**< index of logical core in CPU id table */
202 	queueid_t  tx_queue;     /**< TX queue to send forwarded packets */
203 	volatile char stopped;   /**< stop forwarding when set */
204 };
205 
206 /*
207  * Forwarding mode operations:
208  *   - IO forwarding mode (default mode)
209  *     Forwards packets unchanged.
210  *
211  *   - MAC forwarding mode
212  *     Set the source and the destination Ethernet addresses of packets
213  *     before forwarding them.
214  *
215  *   - IEEE1588 forwarding mode
216  *     Check that received IEEE1588 Precise Time Protocol (PTP) packets are
217  *     filtered and timestamped by the hardware.
218  *     Forwards packets unchanged on the same port.
219  *     Check that sent IEEE1588 PTP packets are timestamped by the hardware.
220  */
221 typedef void (*port_fwd_begin_t)(portid_t pi);
222 typedef void (*port_fwd_end_t)(portid_t pi);
223 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
224 
225 struct fwd_engine {
226 	const char       *fwd_mode_name; /**< Forwarding mode name. */
227 	port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
228 	port_fwd_end_t   port_fwd_end;   /**< NULL if nothing special to do. */
229 	packet_fwd_t     packet_fwd;     /**< Mandatory. */
230 };
231 
232 #define BURST_TX_WAIT_US 1
233 #define BURST_TX_RETRIES 64
234 
235 extern uint32_t burst_tx_delay_time;
236 extern uint32_t burst_tx_retry_num;
237 
238 extern struct fwd_engine io_fwd_engine;
239 extern struct fwd_engine mac_fwd_engine;
240 extern struct fwd_engine mac_swap_engine;
241 extern struct fwd_engine flow_gen_engine;
242 extern struct fwd_engine rx_only_engine;
243 extern struct fwd_engine tx_only_engine;
244 extern struct fwd_engine csum_fwd_engine;
245 extern struct fwd_engine icmp_echo_engine;
246 #ifdef SOFTNIC
247 extern struct fwd_engine softnic_fwd_engine;
248 #endif
249 #ifdef RTE_LIBRTE_IEEE1588
250 extern struct fwd_engine ieee1588_fwd_engine;
251 #endif
252 
253 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
254 
255 /**
256  * Forwarding Configuration
257  *
258  */
259 struct fwd_config {
260 	struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
261 	streamid_t nb_fwd_streams;  /**< Nb. of forward streams to process. */
262 	lcoreid_t  nb_fwd_lcores;   /**< Nb. of logical cores to launch. */
263 	portid_t   nb_fwd_ports;    /**< Nb. of ports involved. */
264 };
265 
266 /**
267  * DCB mode enable
268  */
269 enum dcb_mode_enable
270 {
271 	DCB_VT_ENABLED,
272 	DCB_ENABLED
273 };
274 
275 #define MAX_TX_QUEUE_STATS_MAPPINGS 1024 /* MAX_PORT of 32 @ 32 tx_queues/port */
276 #define MAX_RX_QUEUE_STATS_MAPPINGS 4096 /* MAX_PORT of 32 @ 128 rx_queues/port */
277 
278 struct queue_stats_mappings {
279 	portid_t port_id;
280 	uint16_t queue_id;
281 	uint8_t stats_counter_id;
282 } __rte_cache_aligned;
283 
284 extern struct queue_stats_mappings tx_queue_stats_mappings_array[];
285 extern struct queue_stats_mappings rx_queue_stats_mappings_array[];
286 
287 /* Assign both tx and rx queue stats mappings to the same default values */
288 extern struct queue_stats_mappings *tx_queue_stats_mappings;
289 extern struct queue_stats_mappings *rx_queue_stats_mappings;
290 
291 extern uint16_t nb_tx_queue_stats_mappings;
292 extern uint16_t nb_rx_queue_stats_mappings;
293 
294 extern uint8_t xstats_hide_zero; /**< Hide zero values for xstats display */
295 
296 /* globals used for configuration */
297 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
298 extern int testpmd_logtype; /**< Log type for testpmd logs */
299 extern uint8_t  interactive;
300 extern uint8_t  auto_start;
301 extern uint8_t  tx_first;
302 extern char cmdline_filename[PATH_MAX]; /**< offline commands file */
303 extern uint8_t  numa_support; /**< set by "--numa" parameter */
304 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
305 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
306 extern uint8_t flow_isolate_all; /**< set by "--flow-isolate-all */
307 extern uint8_t  mp_anon; /**< set by "--mp-anon" parameter */
308 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
309 extern volatile int test_done; /* stop packet forwarding when set to 1. */
310 extern uint8_t lsc_interrupt; /**< disabled by "--no-lsc-interrupt" parameter */
311 extern uint8_t rmv_interrupt; /**< disabled by "--no-rmv-interrupt" parameter */
312 extern uint32_t event_print_mask;
313 /**< set by "--print-event xxxx" and "--mask-event xxxx parameters */
314 extern uint8_t hot_plug; /**< enable by "--hot-plug" parameter */
315 extern int do_mlockall; /**< set by "--mlockall" or "--no-mlockall" parameter */
316 
317 #ifdef RTE_LIBRTE_IXGBE_BYPASS
318 extern uint32_t bypass_timeout; /**< Store the NIC bypass watchdog timeout */
319 #endif
320 
321 /*
322  * Store specified sockets on which memory pool to be used by ports
323  * is allocated.
324  */
325 extern uint8_t port_numa[RTE_MAX_ETHPORTS];
326 
327 /*
328  * Store specified sockets on which RX ring to be used by ports
329  * is allocated.
330  */
331 extern uint8_t rxring_numa[RTE_MAX_ETHPORTS];
332 
333 /*
334  * Store specified sockets on which TX ring to be used by ports
335  * is allocated.
336  */
337 extern uint8_t txring_numa[RTE_MAX_ETHPORTS];
338 
339 extern uint8_t socket_num;
340 
341 /*
342  * Configuration of logical cores:
343  * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
344  */
345 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
346 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
347 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
348 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
349 extern unsigned int num_sockets;
350 extern unsigned int socket_ids[RTE_MAX_NUMA_NODES];
351 
352 /*
353  * Configuration of Ethernet ports:
354  * nb_fwd_ports <= nb_cfg_ports <= nb_ports
355  */
356 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
357 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
358 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
359 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
360 extern struct rte_port *ports;
361 
362 extern struct rte_eth_rxmode rx_mode;
363 extern struct rte_eth_txmode tx_mode;
364 
365 extern uint64_t rss_hf;
366 
367 extern queueid_t nb_rxq;
368 extern queueid_t nb_txq;
369 
370 extern uint16_t nb_rxd;
371 extern uint16_t nb_txd;
372 
373 extern int16_t rx_free_thresh;
374 extern int8_t rx_drop_en;
375 extern int16_t tx_free_thresh;
376 extern int16_t tx_rs_thresh;
377 
378 extern uint8_t dcb_config;
379 extern uint8_t dcb_test;
380 
381 extern uint16_t mbuf_data_size; /**< Mbuf data space size. */
382 extern uint32_t param_total_num_mbufs;
383 
384 extern uint16_t stats_period;
385 
386 #ifdef RTE_LIBRTE_LATENCY_STATS
387 extern uint8_t latencystats_enabled;
388 extern lcoreid_t latencystats_lcore_id;
389 #endif
390 
391 #ifdef RTE_LIBRTE_BITRATE
392 extern lcoreid_t bitrate_lcore_id;
393 extern uint8_t bitrate_enabled;
394 #endif
395 
396 extern struct rte_fdir_conf fdir_conf;
397 
398 /*
399  * Configuration of packet segments used by the "txonly" processing engine.
400  */
401 #define TXONLY_DEF_PACKET_LEN 64
402 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
403 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
404 extern uint8_t  tx_pkt_nb_segs; /**< Number of segments in TX packets */
405 
406 enum tx_pkt_split {
407 	TX_PKT_SPLIT_OFF,
408 	TX_PKT_SPLIT_ON,
409 	TX_PKT_SPLIT_RND,
410 };
411 
412 extern enum tx_pkt_split tx_pkt_split;
413 
414 extern uint16_t nb_pkt_per_burst;
415 extern uint16_t mb_mempool_cache;
416 extern int8_t rx_pthresh;
417 extern int8_t rx_hthresh;
418 extern int8_t rx_wthresh;
419 extern int8_t tx_pthresh;
420 extern int8_t tx_hthresh;
421 extern int8_t tx_wthresh;
422 
423 extern struct fwd_config cur_fwd_config;
424 extern struct fwd_engine *cur_fwd_eng;
425 extern uint32_t retry_enabled;
426 extern struct fwd_lcore  **fwd_lcores;
427 extern struct fwd_stream **fwd_streams;
428 
429 extern uint16_t vxlan_gpe_udp_port; /**< UDP port of tunnel VXLAN-GPE. */
430 
431 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
432 extern struct ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
433 
434 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
435 extern uint32_t burst_tx_retry_num;  /**< Burst tx retry number for mac-retry. */
436 
437 #define GRO_DEFAULT_ITEM_NUM_PER_FLOW 32
438 #define GRO_DEFAULT_FLOW_NUM (RTE_GRO_MAX_BURST_ITEM_NUM / \
439 		GRO_DEFAULT_ITEM_NUM_PER_FLOW)
440 
441 #define GRO_DEFAULT_FLUSH_CYCLES 1
442 #define GRO_MAX_FLUSH_CYCLES 4
443 
444 struct gro_status {
445 	struct rte_gro_param param;
446 	uint8_t enable;
447 };
448 extern struct gro_status gro_ports[RTE_MAX_ETHPORTS];
449 extern uint8_t gro_flush_cycles;
450 
451 #define GSO_MAX_PKT_BURST 2048
452 struct gso_status {
453 	uint8_t enable;
454 };
455 extern struct gso_status gso_ports[RTE_MAX_ETHPORTS];
456 extern uint16_t gso_max_segment_size;
457 
458 static inline unsigned int
459 lcore_num(void)
460 {
461 	unsigned int i;
462 
463 	for (i = 0; i < RTE_MAX_LCORE; ++i)
464 		if (fwd_lcores_cpuids[i] == rte_lcore_id())
465 			return i;
466 
467 	rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
468 }
469 
470 static inline struct fwd_lcore *
471 current_fwd_lcore(void)
472 {
473 	return fwd_lcores[lcore_num()];
474 }
475 
476 /* Mbuf Pools */
477 static inline void
478 mbuf_poolname_build(unsigned int sock_id, char* mp_name, int name_size)
479 {
480 	snprintf(mp_name, name_size, "mbuf_pool_socket_%u", sock_id);
481 }
482 
483 static inline struct rte_mempool *
484 mbuf_pool_find(unsigned int sock_id)
485 {
486 	char pool_name[RTE_MEMPOOL_NAMESIZE];
487 
488 	mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name));
489 	return rte_mempool_lookup((const char *)pool_name);
490 }
491 
492 /**
493  * Read/Write operations on a PCI register of a port.
494  */
495 static inline uint32_t
496 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
497 {
498 	const struct rte_pci_device *pci_dev;
499 	const struct rte_bus *bus;
500 	void *reg_addr;
501 	uint32_t reg_v;
502 
503 	if (!port->dev_info.device) {
504 		printf("Invalid device\n");
505 		return 0;
506 	}
507 
508 	bus = rte_bus_find_by_device(port->dev_info.device);
509 	if (bus && !strcmp(bus->name, "pci")) {
510 		pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
511 	} else {
512 		printf("Not a PCI device\n");
513 		return 0;
514 	}
515 
516 	reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
517 	reg_v = *((volatile uint32_t *)reg_addr);
518 	return rte_le_to_cpu_32(reg_v);
519 }
520 
521 #define port_id_pci_reg_read(pt_id, reg_off) \
522 	port_pci_reg_read(&ports[(pt_id)], (reg_off))
523 
524 static inline void
525 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
526 {
527 	const struct rte_pci_device *pci_dev;
528 	const struct rte_bus *bus;
529 	void *reg_addr;
530 
531 	if (!port->dev_info.device) {
532 		printf("Invalid device\n");
533 		return;
534 	}
535 
536 	bus = rte_bus_find_by_device(port->dev_info.device);
537 	if (bus && !strcmp(bus->name, "pci")) {
538 		pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
539 	} else {
540 		printf("Not a PCI device\n");
541 		return;
542 	}
543 
544 	reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
545 	*((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
546 }
547 
548 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
549 	port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
550 
551 /* Prototypes */
552 unsigned int parse_item_list(char* str, const char* item_name,
553 			unsigned int max_items,
554 			unsigned int *parsed_items, int check_unique_values);
555 void launch_args_parse(int argc, char** argv);
556 void cmdline_read_from_file(const char *filename);
557 void prompt(void);
558 void prompt_exit(void);
559 void nic_stats_display(portid_t port_id);
560 void nic_stats_clear(portid_t port_id);
561 void nic_xstats_display(portid_t port_id);
562 void nic_xstats_clear(portid_t port_id);
563 void nic_stats_mapping_display(portid_t port_id);
564 void port_infos_display(portid_t port_id);
565 void port_offload_cap_display(portid_t port_id);
566 void rx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
567 void tx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
568 void fwd_lcores_config_display(void);
569 void pkt_fwd_config_display(struct fwd_config *cfg);
570 void rxtx_config_display(void);
571 void fwd_config_setup(void);
572 void set_def_fwd_config(void);
573 void reconfig(portid_t new_port_id, unsigned socket_id);
574 int init_fwd_streams(void);
575 void update_fwd_ports(portid_t new_pid);
576 
577 void set_fwd_eth_peer(portid_t port_id, char *peer_addr);
578 
579 void port_mtu_set(portid_t port_id, uint16_t mtu);
580 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
581 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
582 		      uint8_t bit_v);
583 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
584 				uint8_t bit1_pos, uint8_t bit2_pos);
585 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
586 			    uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
587 void port_reg_display(portid_t port_id, uint32_t reg_off);
588 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
589 int port_flow_validate(portid_t port_id,
590 		       const struct rte_flow_attr *attr,
591 		       const struct rte_flow_item *pattern,
592 		       const struct rte_flow_action *actions);
593 int port_flow_create(portid_t port_id,
594 		     const struct rte_flow_attr *attr,
595 		     const struct rte_flow_item *pattern,
596 		     const struct rte_flow_action *actions);
597 int port_flow_destroy(portid_t port_id, uint32_t n, const uint32_t *rule);
598 int port_flow_flush(portid_t port_id);
599 int port_flow_query(portid_t port_id, uint32_t rule,
600 		    const struct rte_flow_action *action);
601 void port_flow_list(portid_t port_id, uint32_t n, const uint32_t *group);
602 int port_flow_isolate(portid_t port_id, int set);
603 
604 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
605 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
606 
607 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
608 int set_fwd_lcores_mask(uint64_t lcoremask);
609 void set_fwd_lcores_number(uint16_t nb_lc);
610 
611 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
612 void set_fwd_ports_mask(uint64_t portmask);
613 void set_fwd_ports_number(uint16_t nb_pt);
614 int port_is_forwarding(portid_t port_id);
615 
616 void rx_vlan_strip_set(portid_t port_id, int on);
617 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
618 
619 void rx_vlan_filter_set(portid_t port_id, int on);
620 void rx_vlan_all_filter_set(portid_t port_id, int on);
621 int rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
622 void vlan_extend_set(portid_t port_id, int on);
623 void vlan_tpid_set(portid_t port_id, enum rte_vlan_type vlan_type,
624 		   uint16_t tp_id);
625 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
626 void tx_qinq_set(portid_t port_id, uint16_t vlan_id, uint16_t vlan_id_outer);
627 void tx_vlan_reset(portid_t port_id);
628 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
629 
630 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
631 
632 void set_xstats_hide_zero(uint8_t on_off);
633 
634 void set_verbose_level(uint16_t vb_level);
635 void set_tx_pkt_segments(unsigned *seg_lengths, unsigned nb_segs);
636 void show_tx_pkt_segments(void);
637 void set_tx_pkt_split(const char *name);
638 void set_nb_pkt_per_burst(uint16_t pkt_burst);
639 char *list_pkt_forwarding_modes(void);
640 char *list_pkt_forwarding_retry_modes(void);
641 void set_pkt_forwarding_mode(const char *fwd_mode);
642 void start_packet_forwarding(int with_tx_first);
643 void stop_packet_forwarding(void);
644 void dev_set_link_up(portid_t pid);
645 void dev_set_link_down(portid_t pid);
646 void init_port_config(void);
647 void set_port_slave_flag(portid_t slave_pid);
648 void clear_port_slave_flag(portid_t slave_pid);
649 uint8_t port_is_bonding_slave(portid_t slave_pid);
650 
651 int init_port_dcb_config(portid_t pid, enum dcb_mode_enable dcb_mode,
652 		     enum rte_eth_nb_tcs num_tcs,
653 		     uint8_t pfc_en);
654 int start_port(portid_t pid);
655 void stop_port(portid_t pid);
656 void close_port(portid_t pid);
657 void reset_port(portid_t pid);
658 void attach_port(char *identifier);
659 void detach_port(portid_t port_id);
660 int all_ports_stopped(void);
661 int port_is_stopped(portid_t port_id);
662 int port_is_started(portid_t port_id);
663 void pmd_test_exit(void);
664 void fdir_get_infos(portid_t port_id);
665 void fdir_set_flex_mask(portid_t port_id,
666 			   struct rte_eth_fdir_flex_mask *cfg);
667 void fdir_set_flex_payload(portid_t port_id,
668 			   struct rte_eth_flex_payload_cfg *cfg);
669 void port_rss_reta_info(portid_t port_id,
670 			struct rte_eth_rss_reta_entry64 *reta_conf,
671 			uint16_t nb_entries);
672 
673 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
674 
675 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
676 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
677 				uint64_t q_msk);
678 
679 void port_rss_hash_conf_show(portid_t port_id, char rss_info[],
680 			     int show_rss_key);
681 void port_rss_hash_key_update(portid_t port_id, char rss_type[],
682 			      uint8_t *hash_key, uint hash_key_len);
683 int rx_queue_id_is_invalid(queueid_t rxq_id);
684 int tx_queue_id_is_invalid(queueid_t txq_id);
685 void setup_gro(const char *onoff, portid_t port_id);
686 void setup_gro_flush_cycles(uint8_t cycles);
687 void show_gro(portid_t port_id);
688 void setup_gso(const char *mode, portid_t port_id);
689 
690 /* Functions to manage the set of filtered Multicast MAC addresses */
691 void mcast_addr_add(portid_t port_id, struct ether_addr *mc_addr);
692 void mcast_addr_remove(portid_t port_id, struct ether_addr *mc_addr);
693 void port_dcb_info_display(portid_t port_id);
694 
695 uint8_t *open_file(const char *file_path, uint32_t *size);
696 int save_file(const char *file_path, uint8_t *buf, uint32_t size);
697 int close_file(uint8_t *buf);
698 
699 void port_queue_region_info_display(portid_t port_id, void *buf);
700 
701 enum print_warning {
702 	ENABLED_WARN = 0,
703 	DISABLED_WARN
704 };
705 int port_id_is_invalid(portid_t port_id, enum print_warning warning);
706 void print_valid_ports(void);
707 int new_socket_id(unsigned int socket_id);
708 
709 queueid_t get_allowed_max_nb_rxq(portid_t *pid);
710 int check_nb_rxq(queueid_t rxq);
711 queueid_t get_allowed_max_nb_txq(portid_t *pid);
712 int check_nb_txq(queueid_t txq);
713 
714 /*
715  * Work-around of a compilation error with ICC on invocations of the
716  * rte_be_to_cpu_16() function.
717  */
718 #ifdef __GCC__
719 #define RTE_BE_TO_CPU_16(be_16_v)  rte_be_to_cpu_16((be_16_v))
720 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
721 #else
722 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
723 #define RTE_BE_TO_CPU_16(be_16_v)  (be_16_v)
724 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
725 #else
726 #define RTE_BE_TO_CPU_16(be_16_v) \
727 	(uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
728 #define RTE_CPU_TO_BE_16(cpu_16_v) \
729 	(uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
730 #endif
731 #endif /* __GCC__ */
732 
733 #define TESTPMD_LOG(level, fmt, args...) \
734 	rte_log(RTE_LOG_ ## level, testpmd_logtype, "testpmd: " fmt, ## args)
735 
736 #endif /* _TESTPMD_H_ */
737