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