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