xref: /dpdk/app/test-pmd/testpmd.h (revision 1315219a22a32aa438de3483eaacc104890ee71f)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef _TESTPMD_H_
35 #define _TESTPMD_H_
36 
37 #define RTE_PORT_ALL            (~(portid_t)0x0)
38 
39 #define RTE_TEST_RX_DESC_MAX    2048
40 #define RTE_TEST_TX_DESC_MAX    2048
41 
42 #define RTE_PORT_STOPPED        (uint16_t)0
43 #define RTE_PORT_STARTED        (uint16_t)1
44 #define RTE_PORT_CLOSED         (uint16_t)2
45 #define RTE_PORT_HANDLING       (uint16_t)3
46 
47 /*
48  * It is used to allocate the memory for hash key.
49  * The hash key size is NIC dependent.
50  */
51 #define RSS_HASH_KEY_LENGTH 64
52 
53 /*
54  * Default size of the mbuf data buffer to receive standard 1518-byte
55  * Ethernet frames in a mono-segment memory buffer.
56  */
57 #define DEFAULT_MBUF_DATA_SIZE RTE_MBUF_DEFAULT_BUF_SIZE
58 /**< Default size of mbuf data buffer. */
59 
60 /*
61  * The maximum number of segments per packet is used when creating
62  * scattered transmit packets composed of a list of mbufs.
63  */
64 #define RTE_MAX_SEGS_PER_PKT 255 /**< nb_segs is a 8-bit unsigned char. */
65 
66 #define MAX_PKT_BURST 512
67 #define DEF_PKT_BURST 32
68 
69 #define DEF_MBUF_CACHE 250
70 
71 #define RTE_CACHE_LINE_SIZE_ROUNDUP(size) \
72 	(RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
73 
74 #define NUMA_NO_CONFIG 0xFF
75 #define UMA_NO_CONFIG  0xFF
76 
77 typedef uint8_t  lcoreid_t;
78 typedef uint8_t  portid_t;
79 typedef uint16_t queueid_t;
80 typedef uint16_t streamid_t;
81 
82 #define MAX_QUEUE_ID ((1 << (sizeof(queueid_t) * 8)) - 1)
83 
84 enum {
85 	PORT_TOPOLOGY_PAIRED,
86 	PORT_TOPOLOGY_CHAINED,
87 	PORT_TOPOLOGY_LOOP,
88 };
89 
90 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
91 /**
92  * The data structure associated with RX and TX packet burst statistics
93  * that are recorded for each forwarding stream.
94  */
95 struct pkt_burst_stats {
96 	unsigned int pkt_burst_spread[MAX_PKT_BURST];
97 };
98 #endif
99 
100 /**
101  * The data structure associated with a forwarding stream between a receive
102  * port/queue and a transmit port/queue.
103  */
104 struct fwd_stream {
105 	/* "read-only" data */
106 	portid_t   rx_port;   /**< port to poll for received packets */
107 	queueid_t  rx_queue;  /**< RX queue to poll on "rx_port" */
108 	portid_t   tx_port;   /**< forwarding port of received packets */
109 	queueid_t  tx_queue;  /**< TX queue to send forwarded packets */
110 	streamid_t peer_addr; /**< index of peer ethernet address of packets */
111 
112 	unsigned int retry_enabled;
113 
114 	/* "read-write" results */
115 	unsigned int rx_packets;  /**< received packets */
116 	unsigned int tx_packets;  /**< received packets transmitted */
117 	unsigned int fwd_dropped; /**< received packets not forwarded */
118 	unsigned int rx_bad_ip_csum ; /**< received packets has bad ip checksum */
119 	unsigned int rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
120 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
121 	uint64_t     core_cycles; /**< used for RX and TX processing */
122 #endif
123 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
124 	struct pkt_burst_stats rx_burst_stats;
125 	struct pkt_burst_stats tx_burst_stats;
126 #endif
127 };
128 
129 /** Offload IP checksum in csum forward engine */
130 #define TESTPMD_TX_OFFLOAD_IP_CKSUM          0x0001
131 /** Offload UDP checksum in csum forward engine */
132 #define TESTPMD_TX_OFFLOAD_UDP_CKSUM         0x0002
133 /** Offload TCP checksum in csum forward engine */
134 #define TESTPMD_TX_OFFLOAD_TCP_CKSUM         0x0004
135 /** Offload SCTP checksum in csum forward engine */
136 #define TESTPMD_TX_OFFLOAD_SCTP_CKSUM        0x0008
137 /** Offload outer IP checksum in csum forward engine for recognized tunnels */
138 #define TESTPMD_TX_OFFLOAD_OUTER_IP_CKSUM    0x0010
139 /** Parse tunnel in csum forward engine. If set, dissect tunnel headers
140  * of rx packets. If not set, treat inner headers as payload. */
141 #define TESTPMD_TX_OFFLOAD_PARSE_TUNNEL      0x0020
142 /** Insert VLAN header in forward engine */
143 #define TESTPMD_TX_OFFLOAD_INSERT_VLAN       0x0040
144 /** Insert double VLAN header in forward engine */
145 #define TESTPMD_TX_OFFLOAD_INSERT_QINQ       0x0080
146 /** Offload MACsec in forward engine */
147 #define TESTPMD_TX_OFFLOAD_MACSEC            0x0100
148 
149 /** Descriptor for a single flow. */
150 struct port_flow {
151 	size_t size; /**< Allocated space including data[]. */
152 	struct port_flow *next; /**< Next flow in list. */
153 	struct port_flow *tmp; /**< Temporary linking. */
154 	uint32_t id; /**< Flow rule ID. */
155 	struct rte_flow *flow; /**< Opaque flow object returned by PMD. */
156 	struct rte_flow_attr attr; /**< Attributes. */
157 	struct rte_flow_item *pattern; /**< Pattern. */
158 	struct rte_flow_action *actions; /**< Actions. */
159 	uint8_t data[]; /**< Storage for pattern/actions. */
160 };
161 
162 /**
163  * The data structure associated with each port.
164  */
165 struct rte_port {
166 	uint8_t                 enabled;    /**< Port enabled or not */
167 	struct rte_eth_dev_info dev_info;   /**< PCI info + driver name */
168 	struct rte_eth_conf     dev_conf;   /**< Port configuration. */
169 	struct ether_addr       eth_addr;   /**< Port ethernet address */
170 	struct rte_eth_stats    stats;      /**< Last port statistics */
171 	uint64_t                tx_dropped; /**< If no descriptor in TX ring */
172 	struct fwd_stream       *rx_stream; /**< Port RX stream, if unique */
173 	struct fwd_stream       *tx_stream; /**< Port TX stream, if unique */
174 	unsigned int            socket_id;  /**< For NUMA support */
175 	uint16_t                tx_ol_flags;/**< TX Offload Flags (TESTPMD_TX_OFFLOAD...). */
176 	uint16_t                tso_segsz;  /**< Segmentation offload MSS for non-tunneled packets. */
177 	uint16_t                tunnel_tso_segsz; /**< Segmentation offload MSS for tunneled pkts. */
178 	uint16_t                tx_vlan_id;/**< The tag ID */
179 	uint16_t                tx_vlan_id_outer;/**< The outer tag ID */
180 	void                    *fwd_ctx;   /**< Forwarding mode context */
181 	uint64_t                rx_bad_ip_csum; /**< rx pkts with bad ip checksum  */
182 	uint64_t                rx_bad_l4_csum; /**< rx pkts with bad l4 checksum */
183 	uint8_t                 tx_queue_stats_mapping_enabled;
184 	uint8_t                 rx_queue_stats_mapping_enabled;
185 	volatile uint16_t        port_status;    /**< port started or not */
186 	uint8_t                 need_reconfig;  /**< need reconfiguring port or not */
187 	uint8_t                 need_reconfig_queues; /**< need reconfiguring queues or not */
188 	uint8_t                 rss_flag;   /**< enable rss or not */
189 	uint8_t                 dcb_flag;   /**< enable dcb */
190 	struct rte_eth_rxconf   rx_conf;    /**< rx configuration */
191 	struct rte_eth_txconf   tx_conf;    /**< tx configuration */
192 	struct ether_addr       *mc_addr_pool; /**< pool of multicast addrs */
193 	uint32_t                mc_addr_nb; /**< nb. of addr. in mc_addr_pool */
194 	uint8_t                 slave_flag; /**< bonding slave port */
195 	struct port_flow        *flow_list; /**< Associated flows. */
196 };
197 
198 extern portid_t __rte_unused
199 find_next_port(portid_t p, struct rte_port *ports, int size);
200 
201 #define FOREACH_PORT(p, ports) \
202 	for (p = find_next_port(0, ports, RTE_MAX_ETHPORTS); \
203 	    p < RTE_MAX_ETHPORTS; \
204 	    p = find_next_port(p + 1, ports, RTE_MAX_ETHPORTS))
205 
206 /**
207  * The data structure associated with each forwarding logical core.
208  * The logical cores are internally numbered by a core index from 0 to
209  * the maximum number of logical cores - 1.
210  * The system CPU identifier of all logical cores are setup in a global
211  * CPU id. configuration table.
212  */
213 struct fwd_lcore {
214 	struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
215 	streamid_t stream_idx;   /**< index of 1st stream in "fwd_streams" */
216 	streamid_t stream_nb;    /**< number of streams in "fwd_streams" */
217 	lcoreid_t  cpuid_idx;    /**< index of logical core in CPU id table */
218 	queueid_t  tx_queue;     /**< TX queue to send forwarded packets */
219 	volatile char stopped;   /**< stop forwarding when set */
220 };
221 
222 /*
223  * Forwarding mode operations:
224  *   - IO forwarding mode (default mode)
225  *     Forwards packets unchanged.
226  *
227  *   - MAC forwarding mode
228  *     Set the source and the destination Ethernet addresses of packets
229  *     before forwarding them.
230  *
231  *   - IEEE1588 forwarding mode
232  *     Check that received IEEE1588 Precise Time Protocol (PTP) packets are
233  *     filtered and timestamped by the hardware.
234  *     Forwards packets unchanged on the same port.
235  *     Check that sent IEEE1588 PTP packets are timestamped by the hardware.
236  */
237 typedef void (*port_fwd_begin_t)(portid_t pi);
238 typedef void (*port_fwd_end_t)(portid_t pi);
239 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
240 
241 struct fwd_engine {
242 	const char       *fwd_mode_name; /**< Forwarding mode name. */
243 	port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
244 	port_fwd_end_t   port_fwd_end;   /**< NULL if nothing special to do. */
245 	packet_fwd_t     packet_fwd;     /**< Mandatory. */
246 };
247 
248 #define BURST_TX_WAIT_US 1
249 #define BURST_TX_RETRIES 64
250 
251 extern uint32_t burst_tx_delay_time;
252 extern uint32_t burst_tx_retry_num;
253 
254 extern struct fwd_engine io_fwd_engine;
255 extern struct fwd_engine mac_fwd_engine;
256 extern struct fwd_engine mac_swap_engine;
257 extern struct fwd_engine flow_gen_engine;
258 extern struct fwd_engine rx_only_engine;
259 extern struct fwd_engine tx_only_engine;
260 extern struct fwd_engine csum_fwd_engine;
261 extern struct fwd_engine icmp_echo_engine;
262 #ifdef RTE_LIBRTE_IEEE1588
263 extern struct fwd_engine ieee1588_fwd_engine;
264 #endif
265 
266 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
267 
268 /**
269  * Forwarding Configuration
270  *
271  */
272 struct fwd_config {
273 	struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
274 	streamid_t nb_fwd_streams;  /**< Nb. of forward streams to process. */
275 	lcoreid_t  nb_fwd_lcores;   /**< Nb. of logical cores to launch. */
276 	portid_t   nb_fwd_ports;    /**< Nb. of ports involved. */
277 };
278 
279 /**
280  * DCB mode enable
281  */
282 enum dcb_mode_enable
283 {
284 	DCB_VT_ENABLED,
285 	DCB_ENABLED
286 };
287 
288 #define MAX_TX_QUEUE_STATS_MAPPINGS 1024 /* MAX_PORT of 32 @ 32 tx_queues/port */
289 #define MAX_RX_QUEUE_STATS_MAPPINGS 4096 /* MAX_PORT of 32 @ 128 rx_queues/port */
290 
291 struct queue_stats_mappings {
292 	uint8_t port_id;
293 	uint16_t queue_id;
294 	uint8_t stats_counter_id;
295 } __rte_cache_aligned;
296 
297 extern struct queue_stats_mappings tx_queue_stats_mappings_array[];
298 extern struct queue_stats_mappings rx_queue_stats_mappings_array[];
299 
300 /* Assign both tx and rx queue stats mappings to the same default values */
301 extern struct queue_stats_mappings *tx_queue_stats_mappings;
302 extern struct queue_stats_mappings *rx_queue_stats_mappings;
303 
304 extern uint16_t nb_tx_queue_stats_mappings;
305 extern uint16_t nb_rx_queue_stats_mappings;
306 
307 /* globals used for configuration */
308 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
309 extern uint8_t  interactive;
310 extern uint8_t  auto_start;
311 extern uint8_t  numa_support; /**< set by "--numa" parameter */
312 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
313 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
314 extern uint8_t  mp_anon; /**< set by "--mp-anon" parameter */
315 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
316 extern volatile int test_done; /* stop packet forwarding when set to 1. */
317 
318 #ifdef RTE_NIC_BYPASS
319 extern uint32_t bypass_timeout; /**< Store the NIC bypass watchdog timeout */
320 #endif
321 
322 /*
323  * Store specified sockets on which memory pool to be used by ports
324  * is allocated.
325  */
326 uint8_t port_numa[RTE_MAX_ETHPORTS];
327 
328 /*
329  * Store specified sockets on which RX ring to be used by ports
330  * is allocated.
331  */
332 uint8_t rxring_numa[RTE_MAX_ETHPORTS];
333 
334 /*
335  * Store specified sockets on which TX ring to be used by ports
336  * is allocated.
337  */
338 uint8_t txring_numa[RTE_MAX_ETHPORTS];
339 
340 extern uint8_t socket_num;
341 
342 /*
343  * Configuration of logical cores:
344  * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
345  */
346 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
347 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
348 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
349 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
350 extern unsigned max_socket;
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 uint64_t rss_hf;
364 
365 extern queueid_t nb_rxq;
366 extern queueid_t nb_txq;
367 
368 extern uint16_t nb_rxd;
369 extern uint16_t nb_txd;
370 
371 extern int16_t rx_free_thresh;
372 extern int8_t rx_drop_en;
373 extern int16_t tx_free_thresh;
374 extern int16_t tx_rs_thresh;
375 extern int32_t txq_flags;
376 
377 extern uint8_t dcb_config;
378 extern uint8_t dcb_test;
379 extern enum dcb_queue_mapping_mode dcb_q_mapping;
380 
381 extern uint16_t mbuf_data_size; /**< Mbuf data space size. */
382 extern uint32_t param_total_num_mbufs;
383 
384 extern struct rte_fdir_conf fdir_conf;
385 
386 /*
387  * Configuration of packet segments used by the "txonly" processing engine.
388  */
389 #define TXONLY_DEF_PACKET_LEN 64
390 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
391 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
392 extern uint8_t  tx_pkt_nb_segs; /**< Number of segments in TX packets */
393 
394 enum tx_pkt_split {
395 	TX_PKT_SPLIT_OFF,
396 	TX_PKT_SPLIT_ON,
397 	TX_PKT_SPLIT_RND,
398 };
399 
400 extern enum tx_pkt_split tx_pkt_split;
401 
402 extern uint16_t nb_pkt_per_burst;
403 extern uint16_t mb_mempool_cache;
404 extern int8_t rx_pthresh;
405 extern int8_t rx_hthresh;
406 extern int8_t rx_wthresh;
407 extern int8_t tx_pthresh;
408 extern int8_t tx_hthresh;
409 extern int8_t tx_wthresh;
410 
411 extern struct fwd_config cur_fwd_config;
412 extern struct fwd_engine *cur_fwd_eng;
413 extern uint32_t retry_enabled;
414 extern struct fwd_lcore  **fwd_lcores;
415 extern struct fwd_stream **fwd_streams;
416 
417 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
418 extern struct ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
419 
420 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
421 extern uint32_t burst_tx_retry_num;  /**< Burst tx retry number for mac-retry. */
422 
423 static inline unsigned int
424 lcore_num(void)
425 {
426 	unsigned int i;
427 
428 	for (i = 0; i < RTE_MAX_LCORE; ++i)
429 		if (fwd_lcores_cpuids[i] == rte_lcore_id())
430 			return i;
431 
432 	rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
433 }
434 
435 static inline struct fwd_lcore *
436 current_fwd_lcore(void)
437 {
438 	return fwd_lcores[lcore_num()];
439 }
440 
441 /* Mbuf Pools */
442 static inline void
443 mbuf_poolname_build(unsigned int sock_id, char* mp_name, int name_size)
444 {
445 	snprintf(mp_name, name_size, "mbuf_pool_socket_%u", sock_id);
446 }
447 
448 static inline struct rte_mempool *
449 mbuf_pool_find(unsigned int sock_id)
450 {
451 	char pool_name[RTE_MEMPOOL_NAMESIZE];
452 
453 	mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name));
454 	return rte_mempool_lookup((const char *)pool_name);
455 }
456 
457 /**
458  * Read/Write operations on a PCI register of a port.
459  */
460 static inline uint32_t
461 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
462 {
463 	void *reg_addr;
464 	uint32_t reg_v;
465 
466 	reg_addr = (void *)
467 		((char *)port->dev_info.pci_dev->mem_resource[0].addr +
468 			reg_off);
469 	reg_v = *((volatile uint32_t *)reg_addr);
470 	return rte_le_to_cpu_32(reg_v);
471 }
472 
473 #define port_id_pci_reg_read(pt_id, reg_off) \
474 	port_pci_reg_read(&ports[(pt_id)], (reg_off))
475 
476 static inline void
477 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
478 {
479 	void *reg_addr;
480 
481 	reg_addr = (void *)
482 		((char *)port->dev_info.pci_dev->mem_resource[0].addr +
483 			reg_off);
484 	*((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
485 }
486 
487 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
488 	port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
489 
490 /* Prototypes */
491 unsigned int parse_item_list(char* str, const char* item_name,
492 			unsigned int max_items,
493 			unsigned int *parsed_items, int check_unique_values);
494 void launch_args_parse(int argc, char** argv);
495 void prompt(void);
496 void prompt_exit(void);
497 void nic_stats_display(portid_t port_id);
498 void nic_stats_clear(portid_t port_id);
499 void nic_xstats_display(portid_t port_id);
500 void nic_xstats_clear(portid_t port_id);
501 void nic_stats_mapping_display(portid_t port_id);
502 void port_infos_display(portid_t port_id);
503 void port_offload_cap_display(portid_t port_id);
504 void rx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
505 void tx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
506 void fwd_lcores_config_display(void);
507 void pkt_fwd_config_display(struct fwd_config *cfg);
508 void rxtx_config_display(void);
509 void fwd_config_setup(void);
510 void set_def_fwd_config(void);
511 void reconfig(portid_t new_port_id, unsigned socket_id);
512 int init_fwd_streams(void);
513 
514 void port_mtu_set(portid_t port_id, uint16_t mtu);
515 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
516 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
517 		      uint8_t bit_v);
518 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
519 				uint8_t bit1_pos, uint8_t bit2_pos);
520 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
521 			    uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
522 void port_reg_display(portid_t port_id, uint32_t reg_off);
523 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
524 int port_flow_validate(portid_t port_id,
525 		       const struct rte_flow_attr *attr,
526 		       const struct rte_flow_item *pattern,
527 		       const struct rte_flow_action *actions);
528 int port_flow_create(portid_t port_id,
529 		     const struct rte_flow_attr *attr,
530 		     const struct rte_flow_item *pattern,
531 		     const struct rte_flow_action *actions);
532 int port_flow_destroy(portid_t port_id, uint32_t n, const uint32_t *rule);
533 int port_flow_flush(portid_t port_id);
534 int port_flow_query(portid_t port_id, uint32_t rule,
535 		    enum rte_flow_action_type action);
536 void port_flow_list(portid_t port_id, uint32_t n, const uint32_t *group);
537 
538 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
539 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
540 
541 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
542 int set_fwd_lcores_mask(uint64_t lcoremask);
543 void set_fwd_lcores_number(uint16_t nb_lc);
544 
545 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
546 void set_fwd_ports_mask(uint64_t portmask);
547 void set_fwd_ports_number(uint16_t nb_pt);
548 int port_is_forwarding(portid_t port_id);
549 
550 void rx_vlan_strip_set(portid_t port_id, int on);
551 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
552 
553 void rx_vlan_filter_set(portid_t port_id, int on);
554 void rx_vlan_all_filter_set(portid_t port_id, int on);
555 int rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
556 void vlan_extend_set(portid_t port_id, int on);
557 void vlan_tpid_set(portid_t port_id, enum rte_vlan_type vlan_type,
558 		   uint16_t tp_id);
559 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
560 void tx_qinq_set(portid_t port_id, uint16_t vlan_id, uint16_t vlan_id_outer);
561 void tx_vlan_reset(portid_t port_id);
562 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
563 
564 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
565 
566 void set_verbose_level(uint16_t vb_level);
567 void set_tx_pkt_segments(unsigned *seg_lengths, unsigned nb_segs);
568 void show_tx_pkt_segments(void);
569 void set_tx_pkt_split(const char *name);
570 void set_nb_pkt_per_burst(uint16_t pkt_burst);
571 char *list_pkt_forwarding_modes(void);
572 char *list_pkt_forwarding_retry_modes(void);
573 void set_pkt_forwarding_mode(const char *fwd_mode);
574 void start_packet_forwarding(int with_tx_first);
575 void stop_packet_forwarding(void);
576 void dev_set_link_up(portid_t pid);
577 void dev_set_link_down(portid_t pid);
578 void init_port_config(void);
579 void set_port_slave_flag(portid_t slave_pid);
580 void clear_port_slave_flag(portid_t slave_pid);
581 uint8_t port_is_bonding_slave(portid_t slave_pid);
582 
583 int init_port_dcb_config(portid_t pid, enum dcb_mode_enable dcb_mode,
584 		     enum rte_eth_nb_tcs num_tcs,
585 		     uint8_t pfc_en);
586 int start_port(portid_t pid);
587 void stop_port(portid_t pid);
588 void close_port(portid_t pid);
589 void attach_port(char *identifier);
590 void detach_port(uint8_t port_id);
591 int all_ports_stopped(void);
592 int port_is_started(portid_t port_id);
593 void pmd_test_exit(void);
594 void fdir_get_infos(portid_t port_id);
595 void fdir_set_flex_mask(portid_t port_id,
596 			   struct rte_eth_fdir_flex_mask *cfg);
597 void fdir_set_flex_payload(portid_t port_id,
598 			   struct rte_eth_flex_payload_cfg *cfg);
599 void port_rss_reta_info(portid_t port_id,
600 			struct rte_eth_rss_reta_entry64 *reta_conf,
601 			uint16_t nb_entries);
602 
603 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
604 
605 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
606 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
607 				uint64_t q_msk);
608 
609 void port_rss_hash_conf_show(portid_t port_id, char rss_info[],
610 			     int show_rss_key);
611 void port_rss_hash_key_update(portid_t port_id, char rss_type[],
612 			      uint8_t *hash_key, uint hash_key_len);
613 void get_syn_filter(uint8_t port_id);
614 void get_ethertype_filter(uint8_t port_id, uint16_t index);
615 void get_2tuple_filter(uint8_t port_id, uint16_t index);
616 void get_5tuple_filter(uint8_t port_id, uint16_t index);
617 int rx_queue_id_is_invalid(queueid_t rxq_id);
618 int tx_queue_id_is_invalid(queueid_t txq_id);
619 
620 /* Functions to manage the set of filtered Multicast MAC addresses */
621 void mcast_addr_add(uint8_t port_id, struct ether_addr *mc_addr);
622 void mcast_addr_remove(uint8_t port_id, struct ether_addr *mc_addr);
623 void port_dcb_info_display(uint8_t port_id);
624 
625 uint8_t *open_ddp_package_file(const char *file_path, uint32_t *size);
626 int close_ddp_package_file(uint8_t *buf);
627 
628 enum print_warning {
629 	ENABLED_WARN = 0,
630 	DISABLED_WARN
631 };
632 int port_id_is_invalid(portid_t port_id, enum print_warning warning);
633 
634 /*
635  * Work-around of a compilation error with ICC on invocations of the
636  * rte_be_to_cpu_16() function.
637  */
638 #ifdef __GCC__
639 #define RTE_BE_TO_CPU_16(be_16_v)  rte_be_to_cpu_16((be_16_v))
640 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
641 #else
642 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
643 #define RTE_BE_TO_CPU_16(be_16_v)  (be_16_v)
644 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
645 #else
646 #define RTE_BE_TO_CPU_16(be_16_v) \
647 	(uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
648 #define RTE_CPU_TO_BE_16(cpu_16_v) \
649 	(uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
650 #endif
651 #endif /* __GCC__ */
652 
653 #endif /* _TESTPMD_H_ */
654