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