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