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