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