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