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