app/testpmd: display/clear forwarding stats on demand
[dpdk.git] / app / test-pmd / testpmd.h
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 uint16_t nb_pkt_per_burst;
436 extern uint16_t mb_mempool_cache;
437 extern int8_t rx_pthresh;
438 extern int8_t rx_hthresh;
439 extern int8_t rx_wthresh;
440 extern int8_t tx_pthresh;
441 extern int8_t tx_hthresh;
442 extern int8_t tx_wthresh;
443
444 extern struct fwd_config cur_fwd_config;
445 extern struct fwd_engine *cur_fwd_eng;
446 extern uint32_t retry_enabled;
447 extern struct fwd_lcore  **fwd_lcores;
448 extern struct fwd_stream **fwd_streams;
449
450 extern uint16_t vxlan_gpe_udp_port; /**< UDP port of tunnel VXLAN-GPE. */
451
452 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
453 extern struct ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
454
455 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
456 extern uint32_t burst_tx_retry_num;  /**< Burst tx retry number for mac-retry. */
457
458 #define GRO_DEFAULT_ITEM_NUM_PER_FLOW 32
459 #define GRO_DEFAULT_FLOW_NUM (RTE_GRO_MAX_BURST_ITEM_NUM / \
460                 GRO_DEFAULT_ITEM_NUM_PER_FLOW)
461
462 #define GRO_DEFAULT_FLUSH_CYCLES 1
463 #define GRO_MAX_FLUSH_CYCLES 4
464
465 struct gro_status {
466         struct rte_gro_param param;
467         uint8_t enable;
468 };
469 extern struct gro_status gro_ports[RTE_MAX_ETHPORTS];
470 extern uint8_t gro_flush_cycles;
471
472 #define GSO_MAX_PKT_BURST 2048
473 struct gso_status {
474         uint8_t enable;
475 };
476 extern struct gso_status gso_ports[RTE_MAX_ETHPORTS];
477 extern uint16_t gso_max_segment_size;
478
479 /* VXLAN encap/decap parameters. */
480 struct vxlan_encap_conf {
481         uint32_t select_ipv4:1;
482         uint32_t select_vlan:1;
483         uint32_t select_tos_ttl:1;
484         uint8_t vni[3];
485         rte_be16_t udp_src;
486         rte_be16_t udp_dst;
487         rte_be32_t ipv4_src;
488         rte_be32_t ipv4_dst;
489         uint8_t ipv6_src[16];
490         uint8_t ipv6_dst[16];
491         rte_be16_t vlan_tci;
492         uint8_t ip_tos;
493         uint8_t ip_ttl;
494         uint8_t eth_src[ETHER_ADDR_LEN];
495         uint8_t eth_dst[ETHER_ADDR_LEN];
496 };
497 struct vxlan_encap_conf vxlan_encap_conf;
498
499 /* NVGRE encap/decap parameters. */
500 struct nvgre_encap_conf {
501         uint32_t select_ipv4:1;
502         uint32_t select_vlan:1;
503         uint8_t tni[3];
504         rte_be32_t ipv4_src;
505         rte_be32_t ipv4_dst;
506         uint8_t ipv6_src[16];
507         uint8_t ipv6_dst[16];
508         rte_be16_t vlan_tci;
509         uint8_t eth_src[ETHER_ADDR_LEN];
510         uint8_t eth_dst[ETHER_ADDR_LEN];
511 };
512 struct nvgre_encap_conf nvgre_encap_conf;
513
514 /* L2 encap parameters. */
515 struct l2_encap_conf {
516         uint32_t select_ipv4:1;
517         uint32_t select_vlan:1;
518         rte_be16_t vlan_tci;
519         uint8_t eth_src[ETHER_ADDR_LEN];
520         uint8_t eth_dst[ETHER_ADDR_LEN];
521 };
522 struct l2_encap_conf l2_encap_conf;
523
524 /* L2 decap parameters. */
525 struct l2_decap_conf {
526         uint32_t select_vlan:1;
527 };
528 struct l2_decap_conf l2_decap_conf;
529
530 /* MPLSoGRE encap parameters. */
531 struct mplsogre_encap_conf {
532         uint32_t select_ipv4:1;
533         uint32_t select_vlan:1;
534         uint8_t label[3];
535         rte_be32_t ipv4_src;
536         rte_be32_t ipv4_dst;
537         uint8_t ipv6_src[16];
538         uint8_t ipv6_dst[16];
539         rte_be16_t vlan_tci;
540         uint8_t eth_src[ETHER_ADDR_LEN];
541         uint8_t eth_dst[ETHER_ADDR_LEN];
542 };
543 struct mplsogre_encap_conf mplsogre_encap_conf;
544
545 /* MPLSoGRE decap parameters. */
546 struct mplsogre_decap_conf {
547         uint32_t select_ipv4:1;
548         uint32_t select_vlan:1;
549 };
550 struct mplsogre_decap_conf mplsogre_decap_conf;
551
552 /* MPLSoUDP encap parameters. */
553 struct mplsoudp_encap_conf {
554         uint32_t select_ipv4:1;
555         uint32_t select_vlan:1;
556         uint8_t label[3];
557         rte_be16_t udp_src;
558         rte_be16_t udp_dst;
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[ETHER_ADDR_LEN];
565         uint8_t eth_dst[ETHER_ADDR_LEN];
566 };
567 struct mplsoudp_encap_conf mplsoudp_encap_conf;
568
569 /* MPLSoUDP decap parameters. */
570 struct mplsoudp_decap_conf {
571         uint32_t select_ipv4:1;
572         uint32_t select_vlan:1;
573 };
574 struct mplsoudp_decap_conf mplsoudp_decap_conf;
575
576 static inline unsigned int
577 lcore_num(void)
578 {
579         unsigned int i;
580
581         for (i = 0; i < RTE_MAX_LCORE; ++i)
582                 if (fwd_lcores_cpuids[i] == rte_lcore_id())
583                         return i;
584
585         rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
586 }
587
588 static inline struct fwd_lcore *
589 current_fwd_lcore(void)
590 {
591         return fwd_lcores[lcore_num()];
592 }
593
594 /* Mbuf Pools */
595 static inline void
596 mbuf_poolname_build(unsigned int sock_id, char* mp_name, int name_size)
597 {
598         snprintf(mp_name, name_size, "mbuf_pool_socket_%u", sock_id);
599 }
600
601 static inline struct rte_mempool *
602 mbuf_pool_find(unsigned int sock_id)
603 {
604         char pool_name[RTE_MEMPOOL_NAMESIZE];
605
606         mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name));
607         return rte_mempool_lookup((const char *)pool_name);
608 }
609
610 /**
611  * Read/Write operations on a PCI register of a port.
612  */
613 static inline uint32_t
614 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
615 {
616         const struct rte_pci_device *pci_dev;
617         const struct rte_bus *bus;
618         void *reg_addr;
619         uint32_t reg_v;
620
621         if (!port->dev_info.device) {
622                 printf("Invalid device\n");
623                 return 0;
624         }
625
626         bus = rte_bus_find_by_device(port->dev_info.device);
627         if (bus && !strcmp(bus->name, "pci")) {
628                 pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
629         } else {
630                 printf("Not a PCI device\n");
631                 return 0;
632         }
633
634         reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
635         reg_v = *((volatile uint32_t *)reg_addr);
636         return rte_le_to_cpu_32(reg_v);
637 }
638
639 #define port_id_pci_reg_read(pt_id, reg_off) \
640         port_pci_reg_read(&ports[(pt_id)], (reg_off))
641
642 static inline void
643 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
644 {
645         const struct rte_pci_device *pci_dev;
646         const struct rte_bus *bus;
647         void *reg_addr;
648
649         if (!port->dev_info.device) {
650                 printf("Invalid device\n");
651                 return;
652         }
653
654         bus = rte_bus_find_by_device(port->dev_info.device);
655         if (bus && !strcmp(bus->name, "pci")) {
656                 pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
657         } else {
658                 printf("Not a PCI device\n");
659                 return;
660         }
661
662         reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
663         *((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
664 }
665
666 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
667         port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
668
669 /* Prototypes */
670 unsigned int parse_item_list(char* str, const char* item_name,
671                         unsigned int max_items,
672                         unsigned int *parsed_items, int check_unique_values);
673 void launch_args_parse(int argc, char** argv);
674 void cmdline_read_from_file(const char *filename);
675 void prompt(void);
676 void prompt_exit(void);
677 void nic_stats_display(portid_t port_id);
678 void nic_stats_clear(portid_t port_id);
679 void nic_xstats_display(portid_t port_id);
680 void nic_xstats_clear(portid_t port_id);
681 void nic_stats_mapping_display(portid_t port_id);
682 void port_infos_display(portid_t port_id);
683 void port_summary_display(portid_t port_id);
684 void port_summary_header_display(void);
685 void port_offload_cap_display(portid_t port_id);
686 void rx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
687 void tx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
688 void fwd_lcores_config_display(void);
689 void pkt_fwd_config_display(struct fwd_config *cfg);
690 void rxtx_config_display(void);
691 void fwd_config_setup(void);
692 void set_def_fwd_config(void);
693 void reconfig(portid_t new_port_id, unsigned socket_id);
694 int init_fwd_streams(void);
695 void update_fwd_ports(portid_t new_pid);
696
697 void set_fwd_eth_peer(portid_t port_id, char *peer_addr);
698
699 void port_mtu_set(portid_t port_id, uint16_t mtu);
700 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
701 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
702                       uint8_t bit_v);
703 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
704                                 uint8_t bit1_pos, uint8_t bit2_pos);
705 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
706                             uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
707 void port_reg_display(portid_t port_id, uint32_t reg_off);
708 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
709 int port_flow_validate(portid_t port_id,
710                        const struct rte_flow_attr *attr,
711                        const struct rte_flow_item *pattern,
712                        const struct rte_flow_action *actions);
713 int port_flow_create(portid_t port_id,
714                      const struct rte_flow_attr *attr,
715                      const struct rte_flow_item *pattern,
716                      const struct rte_flow_action *actions);
717 int port_flow_destroy(portid_t port_id, uint32_t n, const uint32_t *rule);
718 int port_flow_flush(portid_t port_id);
719 int port_flow_query(portid_t port_id, uint32_t rule,
720                     const struct rte_flow_action *action);
721 void port_flow_list(portid_t port_id, uint32_t n, const uint32_t *group);
722 int port_flow_isolate(portid_t port_id, int set);
723
724 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
725 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
726
727 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
728 int set_fwd_lcores_mask(uint64_t lcoremask);
729 void set_fwd_lcores_number(uint16_t nb_lc);
730
731 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
732 void set_fwd_ports_mask(uint64_t portmask);
733 void set_fwd_ports_number(uint16_t nb_pt);
734 int port_is_forwarding(portid_t port_id);
735
736 void rx_vlan_strip_set(portid_t port_id, int on);
737 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
738
739 void rx_vlan_filter_set(portid_t port_id, int on);
740 void rx_vlan_all_filter_set(portid_t port_id, int on);
741 int rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
742 void vlan_extend_set(portid_t port_id, int on);
743 void vlan_tpid_set(portid_t port_id, enum rte_vlan_type vlan_type,
744                    uint16_t tp_id);
745 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
746 void tx_qinq_set(portid_t port_id, uint16_t vlan_id, uint16_t vlan_id_outer);
747 void tx_vlan_reset(portid_t port_id);
748 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
749
750 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
751
752 void set_xstats_hide_zero(uint8_t on_off);
753
754 void set_verbose_level(uint16_t vb_level);
755 void set_tx_pkt_segments(unsigned *seg_lengths, unsigned nb_segs);
756 void show_tx_pkt_segments(void);
757 void set_tx_pkt_split(const char *name);
758 void set_nb_pkt_per_burst(uint16_t pkt_burst);
759 char *list_pkt_forwarding_modes(void);
760 char *list_pkt_forwarding_retry_modes(void);
761 void set_pkt_forwarding_mode(const char *fwd_mode);
762 void start_packet_forwarding(int with_tx_first);
763 void fwd_stats_display(void);
764 void fwd_stats_reset(void);
765 void stop_packet_forwarding(void);
766 void dev_set_link_up(portid_t pid);
767 void dev_set_link_down(portid_t pid);
768 void init_port_config(void);
769 void set_port_slave_flag(portid_t slave_pid);
770 void clear_port_slave_flag(portid_t slave_pid);
771 uint8_t port_is_bonding_slave(portid_t slave_pid);
772
773 int init_port_dcb_config(portid_t pid, enum dcb_mode_enable dcb_mode,
774                      enum rte_eth_nb_tcs num_tcs,
775                      uint8_t pfc_en);
776 int start_port(portid_t pid);
777 void stop_port(portid_t pid);
778 void close_port(portid_t pid);
779 void reset_port(portid_t pid);
780 void attach_port(char *identifier);
781 void detach_port_device(portid_t port_id);
782 int all_ports_stopped(void);
783 int port_is_stopped(portid_t port_id);
784 int port_is_started(portid_t port_id);
785 void pmd_test_exit(void);
786 void fdir_get_infos(portid_t port_id);
787 void fdir_set_flex_mask(portid_t port_id,
788                            struct rte_eth_fdir_flex_mask *cfg);
789 void fdir_set_flex_payload(portid_t port_id,
790                            struct rte_eth_flex_payload_cfg *cfg);
791 void port_rss_reta_info(portid_t port_id,
792                         struct rte_eth_rss_reta_entry64 *reta_conf,
793                         uint16_t nb_entries);
794
795 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
796
797 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
798 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
799                                 uint64_t q_msk);
800
801 void port_rss_hash_conf_show(portid_t port_id, int show_rss_key);
802 void port_rss_hash_key_update(portid_t port_id, char rss_type[],
803                               uint8_t *hash_key, uint hash_key_len);
804 int rx_queue_id_is_invalid(queueid_t rxq_id);
805 int tx_queue_id_is_invalid(queueid_t txq_id);
806 void setup_gro(const char *onoff, portid_t port_id);
807 void setup_gro_flush_cycles(uint8_t cycles);
808 void show_gro(portid_t port_id);
809 void setup_gso(const char *mode, portid_t port_id);
810
811 /* Functions to manage the set of filtered Multicast MAC addresses */
812 void mcast_addr_add(portid_t port_id, struct ether_addr *mc_addr);
813 void mcast_addr_remove(portid_t port_id, struct ether_addr *mc_addr);
814 void port_dcb_info_display(portid_t port_id);
815
816 uint8_t *open_file(const char *file_path, uint32_t *size);
817 int save_file(const char *file_path, uint8_t *buf, uint32_t size);
818 int close_file(uint8_t *buf);
819
820 void port_queue_region_info_display(portid_t port_id, void *buf);
821
822 enum print_warning {
823         ENABLED_WARN = 0,
824         DISABLED_WARN
825 };
826 int port_id_is_invalid(portid_t port_id, enum print_warning warning);
827 void print_valid_ports(void);
828 int new_socket_id(unsigned int socket_id);
829
830 queueid_t get_allowed_max_nb_rxq(portid_t *pid);
831 int check_nb_rxq(queueid_t rxq);
832 queueid_t get_allowed_max_nb_txq(portid_t *pid);
833 int check_nb_txq(queueid_t txq);
834
835 uint16_t dump_rx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
836                       uint16_t nb_pkts, __rte_unused uint16_t max_pkts,
837                       __rte_unused void *user_param);
838
839 uint16_t dump_tx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
840                       uint16_t nb_pkts, __rte_unused void *user_param);
841
842 void add_rx_dump_callbacks(portid_t portid);
843 void remove_rx_dump_callbacks(portid_t portid);
844 void add_tx_dump_callbacks(portid_t portid);
845 void remove_tx_dump_callbacks(portid_t portid);
846 void configure_rxtx_dump_callbacks(uint16_t verbose);
847
848 uint16_t tx_pkt_set_md(uint16_t port_id, __rte_unused uint16_t queue,
849                        struct rte_mbuf *pkts[], uint16_t nb_pkts,
850                        __rte_unused void *user_param);
851 void add_tx_md_callback(portid_t portid);
852 void remove_tx_md_callback(portid_t portid);
853
854 /*
855  * Work-around of a compilation error with ICC on invocations of the
856  * rte_be_to_cpu_16() function.
857  */
858 #ifdef __GCC__
859 #define RTE_BE_TO_CPU_16(be_16_v)  rte_be_to_cpu_16((be_16_v))
860 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
861 #else
862 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
863 #define RTE_BE_TO_CPU_16(be_16_v)  (be_16_v)
864 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
865 #else
866 #define RTE_BE_TO_CPU_16(be_16_v) \
867         (uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
868 #define RTE_CPU_TO_BE_16(cpu_16_v) \
869         (uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
870 #endif
871 #endif /* __GCC__ */
872
873 #define TESTPMD_LOG(level, fmt, args...) \
874         rte_log(RTE_LOG_ ## level, testpmd_logtype, "testpmd: " fmt, ## args)
875
876 #endif /* _TESTPMD_H_ */