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