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