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