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