app/testpmd: introduce new tunnel VXLAN-GPE
[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 && defined RTE_LIBRTE_SCHED
61 #define TM_MODE                 1
62 #else
63 #define TM_MODE                 0
64 #endif
65
66 enum {
67         PORT_TOPOLOGY_PAIRED,
68         PORT_TOPOLOGY_CHAINED,
69         PORT_TOPOLOGY_LOOP,
70 };
71
72 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
73 /**
74  * The data structure associated with RX and TX packet burst statistics
75  * that are recorded for each forwarding stream.
76  */
77 struct pkt_burst_stats {
78         unsigned int pkt_burst_spread[MAX_PKT_BURST];
79 };
80 #endif
81
82 /** Information for a given RSS type. */
83 struct rss_type_info {
84         const char *str; /**< Type name. */
85         uint64_t rss_type; /**< Type value. */
86 };
87
88 /**
89  * RSS type information table.
90  *
91  * An entry with a NULL type name terminates the list.
92  */
93 extern const struct rss_type_info rss_type_table[];
94
95 /**
96  * The data structure associated with a forwarding stream between a receive
97  * port/queue and a transmit port/queue.
98  */
99 struct fwd_stream {
100         /* "read-only" data */
101         portid_t   rx_port;   /**< port to poll for received packets */
102         queueid_t  rx_queue;  /**< RX queue to poll on "rx_port" */
103         portid_t   tx_port;   /**< forwarding port of received packets */
104         queueid_t  tx_queue;  /**< TX queue to send forwarded packets */
105         streamid_t peer_addr; /**< index of peer ethernet address of packets */
106
107         unsigned int retry_enabled;
108
109         /* "read-write" results */
110         unsigned int rx_packets;  /**< received packets */
111         unsigned int tx_packets;  /**< received packets transmitted */
112         unsigned int fwd_dropped; /**< received packets not forwarded */
113         unsigned int rx_bad_ip_csum ; /**< received packets has bad ip checksum */
114         unsigned int rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
115         unsigned int gro_times; /**< GRO operation times */
116 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
117         uint64_t     core_cycles; /**< used for RX and TX processing */
118 #endif
119 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
120         struct pkt_burst_stats rx_burst_stats;
121         struct pkt_burst_stats tx_burst_stats;
122 #endif
123 };
124
125 /** Descriptor for a single flow. */
126 struct port_flow {
127         size_t size; /**< Allocated space including data[]. */
128         struct port_flow *next; /**< Next flow in list. */
129         struct port_flow *tmp; /**< Temporary linking. */
130         uint32_t id; /**< Flow rule ID. */
131         struct rte_flow *flow; /**< Opaque flow object returned by PMD. */
132         struct rte_flow_attr attr; /**< Attributes. */
133         struct rte_flow_item *pattern; /**< Pattern. */
134         struct rte_flow_action *actions; /**< Actions. */
135         uint8_t data[]; /**< Storage for pattern/actions. */
136 };
137
138 #ifdef TM_MODE
139 /**
140  * Soft port tm related parameters
141  */
142 struct softnic_port_tm {
143         uint32_t default_hierarchy_enable; /**< def hierarchy enable flag */
144         uint32_t hierarchy_config;  /**< set to 1 if hierarchy configured */
145
146         uint32_t n_subports_per_port;  /**< Num of subport nodes per port */
147         uint32_t n_pipes_per_subport;  /**< Num of pipe nodes per subport */
148
149         uint64_t tm_pktfield0_slabpos;  /**< Pkt field position for subport */
150         uint64_t tm_pktfield0_slabmask; /**< Pkt field mask for the subport */
151         uint64_t tm_pktfield0_slabshr;
152         uint64_t tm_pktfield1_slabpos; /**< Pkt field position for the pipe */
153         uint64_t tm_pktfield1_slabmask; /**< Pkt field mask for the pipe */
154         uint64_t tm_pktfield1_slabshr;
155         uint64_t tm_pktfield2_slabpos; /**< Pkt field position table index */
156         uint64_t tm_pktfield2_slabmask; /**< Pkt field mask for tc table idx */
157         uint64_t tm_pktfield2_slabshr;
158         uint64_t tm_tc_table[64];  /**< TC translation table */
159 };
160
161 /**
162  * The data structure associate with softnic port
163  */
164 struct softnic_port {
165         unsigned int tm_flag;   /**< set to 1 if tm feature is enabled */
166         struct softnic_port_tm tm;      /**< softnic port tm parameters */
167 };
168 #endif
169
170 /**
171  * The data structure associated with each port.
172  */
173 struct rte_port {
174         struct rte_eth_dev_info dev_info;   /**< PCI info + driver name */
175         struct rte_eth_conf     dev_conf;   /**< Port configuration. */
176         struct ether_addr       eth_addr;   /**< Port ethernet address */
177         struct rte_eth_stats    stats;      /**< Last port statistics */
178         uint64_t                tx_dropped; /**< If no descriptor in TX ring */
179         struct fwd_stream       *rx_stream; /**< Port RX stream, if unique */
180         struct fwd_stream       *tx_stream; /**< Port TX stream, if unique */
181         unsigned int            socket_id;  /**< For NUMA support */
182         uint16_t                parse_tunnel:1; /**< Parse internal headers */
183         uint16_t                tso_segsz;  /**< Segmentation offload MSS for non-tunneled packets. */
184         uint16_t                tunnel_tso_segsz; /**< Segmentation offload MSS for tunneled pkts. */
185         uint16_t                tx_vlan_id;/**< The tag ID */
186         uint16_t                tx_vlan_id_outer;/**< The outer tag ID */
187         void                    *fwd_ctx;   /**< Forwarding mode context */
188         uint64_t                rx_bad_ip_csum; /**< rx pkts with bad ip checksum  */
189         uint64_t                rx_bad_l4_csum; /**< rx pkts with bad l4 checksum */
190         uint8_t                 tx_queue_stats_mapping_enabled;
191         uint8_t                 rx_queue_stats_mapping_enabled;
192         volatile uint16_t        port_status;    /**< port started or not */
193         uint8_t                 need_reconfig;  /**< need reconfiguring port or not */
194         uint8_t                 need_reconfig_queues; /**< need reconfiguring queues or not */
195         uint8_t                 rss_flag;   /**< enable rss or not */
196         uint8_t                 dcb_flag;   /**< enable dcb */
197         uint16_t                nb_rx_desc[MAX_QUEUE_ID+1]; /**< per queue rx desc number */
198         uint16_t                nb_tx_desc[MAX_QUEUE_ID+1]; /**< per queue tx desc number */
199         struct rte_eth_rxconf   rx_conf[MAX_QUEUE_ID+1]; /**< per queue rx configuration */
200         struct rte_eth_txconf   tx_conf[MAX_QUEUE_ID+1]; /**< per queue tx configuration */
201         struct ether_addr       *mc_addr_pool; /**< pool of multicast addrs */
202         uint32_t                mc_addr_nb; /**< nb. of addr. in mc_addr_pool */
203         uint8_t                 slave_flag; /**< bonding slave port */
204         struct port_flow        *flow_list; /**< Associated flows. */
205 #ifdef TM_MODE
206         unsigned int                    softnic_enable; /**< softnic flag */
207         struct softnic_port     softport;  /**< softnic port params */
208 #endif
209 };
210
211 /**
212  * The data structure associated with each forwarding logical core.
213  * The logical cores are internally numbered by a core index from 0 to
214  * the maximum number of logical cores - 1.
215  * The system CPU identifier of all logical cores are setup in a global
216  * CPU id. configuration table.
217  */
218 struct fwd_lcore {
219         struct rte_gso_ctx gso_ctx;     /**< GSO context */
220         struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
221         void *gro_ctx;          /**< GRO context */
222         streamid_t stream_idx;   /**< index of 1st stream in "fwd_streams" */
223         streamid_t stream_nb;    /**< number of streams in "fwd_streams" */
224         lcoreid_t  cpuid_idx;    /**< index of logical core in CPU id table */
225         queueid_t  tx_queue;     /**< TX queue to send forwarded packets */
226         volatile char stopped;   /**< stop forwarding when set */
227 };
228
229 /*
230  * Forwarding mode operations:
231  *   - IO forwarding mode (default mode)
232  *     Forwards packets unchanged.
233  *
234  *   - MAC forwarding mode
235  *     Set the source and the destination Ethernet addresses of packets
236  *     before forwarding them.
237  *
238  *   - IEEE1588 forwarding mode
239  *     Check that received IEEE1588 Precise Time Protocol (PTP) packets are
240  *     filtered and timestamped by the hardware.
241  *     Forwards packets unchanged on the same port.
242  *     Check that sent IEEE1588 PTP packets are timestamped by the hardware.
243  */
244 typedef void (*port_fwd_begin_t)(portid_t pi);
245 typedef void (*port_fwd_end_t)(portid_t pi);
246 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
247
248 struct fwd_engine {
249         const char       *fwd_mode_name; /**< Forwarding mode name. */
250         port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
251         port_fwd_end_t   port_fwd_end;   /**< NULL if nothing special to do. */
252         packet_fwd_t     packet_fwd;     /**< Mandatory. */
253 };
254
255 #define BURST_TX_WAIT_US 1
256 #define BURST_TX_RETRIES 64
257
258 extern uint32_t burst_tx_delay_time;
259 extern uint32_t burst_tx_retry_num;
260
261 extern struct fwd_engine io_fwd_engine;
262 extern struct fwd_engine mac_fwd_engine;
263 extern struct fwd_engine mac_swap_engine;
264 extern struct fwd_engine flow_gen_engine;
265 extern struct fwd_engine rx_only_engine;
266 extern struct fwd_engine tx_only_engine;
267 extern struct fwd_engine csum_fwd_engine;
268 extern struct fwd_engine icmp_echo_engine;
269 #ifdef TM_MODE
270 extern struct fwd_engine softnic_tm_engine;
271 extern struct fwd_engine softnic_tm_bypass_engine;
272 #endif
273 #ifdef RTE_LIBRTE_IEEE1588
274 extern struct fwd_engine ieee1588_fwd_engine;
275 #endif
276
277 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
278
279 /**
280  * Forwarding Configuration
281  *
282  */
283 struct fwd_config {
284         struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
285         streamid_t nb_fwd_streams;  /**< Nb. of forward streams to process. */
286         lcoreid_t  nb_fwd_lcores;   /**< Nb. of logical cores to launch. */
287         portid_t   nb_fwd_ports;    /**< Nb. of ports involved. */
288 };
289
290 /**
291  * DCB mode enable
292  */
293 enum dcb_mode_enable
294 {
295         DCB_VT_ENABLED,
296         DCB_ENABLED
297 };
298
299 #define MAX_TX_QUEUE_STATS_MAPPINGS 1024 /* MAX_PORT of 32 @ 32 tx_queues/port */
300 #define MAX_RX_QUEUE_STATS_MAPPINGS 4096 /* MAX_PORT of 32 @ 128 rx_queues/port */
301
302 struct queue_stats_mappings {
303         portid_t port_id;
304         uint16_t queue_id;
305         uint8_t stats_counter_id;
306 } __rte_cache_aligned;
307
308 extern struct queue_stats_mappings tx_queue_stats_mappings_array[];
309 extern struct queue_stats_mappings rx_queue_stats_mappings_array[];
310
311 /* Assign both tx and rx queue stats mappings to the same default values */
312 extern struct queue_stats_mappings *tx_queue_stats_mappings;
313 extern struct queue_stats_mappings *rx_queue_stats_mappings;
314
315 extern uint16_t nb_tx_queue_stats_mappings;
316 extern uint16_t nb_rx_queue_stats_mappings;
317
318 extern uint8_t xstats_hide_zero; /**< Hide zero values for xstats display */
319
320 /* globals used for configuration */
321 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
322 extern int testpmd_logtype; /**< Log type for testpmd logs */
323 extern uint8_t  interactive;
324 extern uint8_t  auto_start;
325 extern uint8_t  tx_first;
326 extern char cmdline_filename[PATH_MAX]; /**< offline commands file */
327 extern uint8_t  numa_support; /**< set by "--numa" parameter */
328 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
329 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
330 extern uint8_t flow_isolate_all; /**< set by "--flow-isolate-all */
331 extern uint8_t  mp_anon; /**< set by "--mp-anon" parameter */
332 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
333 extern volatile int test_done; /* stop packet forwarding when set to 1. */
334 extern uint8_t lsc_interrupt; /**< disabled by "--no-lsc-interrupt" parameter */
335 extern uint8_t rmv_interrupt; /**< disabled by "--no-rmv-interrupt" parameter */
336 extern uint32_t event_print_mask;
337 extern uint8_t hot_plug; /**< enable by "--hot-plug" parameter */
338
339 /**< set by "--print-event xxxx" and "--mask-event xxxx parameters */
340
341 #ifdef RTE_LIBRTE_IXGBE_BYPASS
342 extern uint32_t bypass_timeout; /**< Store the NIC bypass watchdog timeout */
343 #endif
344
345 /*
346  * Store specified sockets on which memory pool to be used by ports
347  * is allocated.
348  */
349 extern uint8_t port_numa[RTE_MAX_ETHPORTS];
350
351 /*
352  * Store specified sockets on which RX ring to be used by ports
353  * is allocated.
354  */
355 extern uint8_t rxring_numa[RTE_MAX_ETHPORTS];
356
357 /*
358  * Store specified sockets on which TX ring to be used by ports
359  * is allocated.
360  */
361 extern uint8_t txring_numa[RTE_MAX_ETHPORTS];
362
363 extern uint8_t socket_num;
364
365 /*
366  * Configuration of logical cores:
367  * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
368  */
369 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
370 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
371 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
372 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
373 extern unsigned int num_sockets;
374 extern unsigned int socket_ids[RTE_MAX_NUMA_NODES];
375
376 /*
377  * Configuration of Ethernet ports:
378  * nb_fwd_ports <= nb_cfg_ports <= nb_ports
379  */
380 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
381 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
382 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
383 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
384 extern struct rte_port *ports;
385
386 extern struct rte_eth_rxmode rx_mode;
387 extern struct rte_eth_txmode tx_mode;
388
389 extern uint64_t rss_hf;
390
391 extern queueid_t nb_rxq;
392 extern queueid_t nb_txq;
393
394 extern uint16_t nb_rxd;
395 extern uint16_t nb_txd;
396
397 extern int16_t rx_free_thresh;
398 extern int8_t rx_drop_en;
399 extern int16_t tx_free_thresh;
400 extern int16_t tx_rs_thresh;
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 static inline unsigned int
483 lcore_num(void)
484 {
485         unsigned int i;
486
487         for (i = 0; i < RTE_MAX_LCORE; ++i)
488                 if (fwd_lcores_cpuids[i] == rte_lcore_id())
489                         return i;
490
491         rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
492 }
493
494 static inline struct fwd_lcore *
495 current_fwd_lcore(void)
496 {
497         return fwd_lcores[lcore_num()];
498 }
499
500 /* Mbuf Pools */
501 static inline void
502 mbuf_poolname_build(unsigned int sock_id, char* mp_name, int name_size)
503 {
504         snprintf(mp_name, name_size, "mbuf_pool_socket_%u", sock_id);
505 }
506
507 static inline struct rte_mempool *
508 mbuf_pool_find(unsigned int sock_id)
509 {
510         char pool_name[RTE_MEMPOOL_NAMESIZE];
511
512         mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name));
513         return rte_mempool_lookup((const char *)pool_name);
514 }
515
516 /**
517  * Read/Write operations on a PCI register of a port.
518  */
519 static inline uint32_t
520 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
521 {
522         const struct rte_pci_device *pci_dev;
523         const struct rte_bus *bus;
524         void *reg_addr;
525         uint32_t reg_v;
526
527         if (!port->dev_info.device) {
528                 printf("Invalid device\n");
529                 return 0;
530         }
531
532         bus = rte_bus_find_by_device(port->dev_info.device);
533         if (bus && !strcmp(bus->name, "pci")) {
534                 pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
535         } else {
536                 printf("Not a PCI device\n");
537                 return 0;
538         }
539
540         reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
541         reg_v = *((volatile uint32_t *)reg_addr);
542         return rte_le_to_cpu_32(reg_v);
543 }
544
545 #define port_id_pci_reg_read(pt_id, reg_off) \
546         port_pci_reg_read(&ports[(pt_id)], (reg_off))
547
548 static inline void
549 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
550 {
551         const struct rte_pci_device *pci_dev;
552         const struct rte_bus *bus;
553         void *reg_addr;
554
555         if (!port->dev_info.device) {
556                 printf("Invalid device\n");
557                 return;
558         }
559
560         bus = rte_bus_find_by_device(port->dev_info.device);
561         if (bus && !strcmp(bus->name, "pci")) {
562                 pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
563         } else {
564                 printf("Not a PCI device\n");
565                 return;
566         }
567
568         reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
569         *((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
570 }
571
572 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
573         port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
574
575 /* Prototypes */
576 unsigned int parse_item_list(char* str, const char* item_name,
577                         unsigned int max_items,
578                         unsigned int *parsed_items, int check_unique_values);
579 void launch_args_parse(int argc, char** argv);
580 void cmdline_read_from_file(const char *filename);
581 void prompt(void);
582 void prompt_exit(void);
583 void nic_stats_display(portid_t port_id);
584 void nic_stats_clear(portid_t port_id);
585 void nic_xstats_display(portid_t port_id);
586 void nic_xstats_clear(portid_t port_id);
587 void nic_stats_mapping_display(portid_t port_id);
588 void port_infos_display(portid_t port_id);
589 void port_offload_cap_display(portid_t port_id);
590 void rx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
591 void tx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
592 void fwd_lcores_config_display(void);
593 void pkt_fwd_config_display(struct fwd_config *cfg);
594 void rxtx_config_display(void);
595 void fwd_config_setup(void);
596 void set_def_fwd_config(void);
597 void reconfig(portid_t new_port_id, unsigned socket_id);
598 int init_fwd_streams(void);
599
600 void set_fwd_eth_peer(portid_t port_id, char *peer_addr);
601
602 void port_mtu_set(portid_t port_id, uint16_t mtu);
603 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
604 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
605                       uint8_t bit_v);
606 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
607                                 uint8_t bit1_pos, uint8_t bit2_pos);
608 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
609                             uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
610 void port_reg_display(portid_t port_id, uint32_t reg_off);
611 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
612 int port_flow_validate(portid_t port_id,
613                        const struct rte_flow_attr *attr,
614                        const struct rte_flow_item *pattern,
615                        const struct rte_flow_action *actions);
616 int port_flow_create(portid_t port_id,
617                      const struct rte_flow_attr *attr,
618                      const struct rte_flow_item *pattern,
619                      const struct rte_flow_action *actions);
620 int port_flow_destroy(portid_t port_id, uint32_t n, const uint32_t *rule);
621 int port_flow_flush(portid_t port_id);
622 int port_flow_query(portid_t port_id, uint32_t rule,
623                     enum rte_flow_action_type action);
624 void port_flow_list(portid_t port_id, uint32_t n, const uint32_t *group);
625 int port_flow_isolate(portid_t port_id, int set);
626
627 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
628 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
629
630 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
631 int set_fwd_lcores_mask(uint64_t lcoremask);
632 void set_fwd_lcores_number(uint16_t nb_lc);
633
634 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
635 void set_fwd_ports_mask(uint64_t portmask);
636 void set_fwd_ports_number(uint16_t nb_pt);
637 int port_is_forwarding(portid_t port_id);
638
639 void rx_vlan_strip_set(portid_t port_id, int on);
640 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
641
642 void rx_vlan_filter_set(portid_t port_id, int on);
643 void rx_vlan_all_filter_set(portid_t port_id, int on);
644 int rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
645 void vlan_extend_set(portid_t port_id, int on);
646 void vlan_tpid_set(portid_t port_id, enum rte_vlan_type vlan_type,
647                    uint16_t tp_id);
648 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
649 void tx_qinq_set(portid_t port_id, uint16_t vlan_id, uint16_t vlan_id_outer);
650 void tx_vlan_reset(portid_t port_id);
651 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
652
653 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
654
655 void set_xstats_hide_zero(uint8_t on_off);
656
657 void set_verbose_level(uint16_t vb_level);
658 void set_tx_pkt_segments(unsigned *seg_lengths, unsigned nb_segs);
659 void show_tx_pkt_segments(void);
660 void set_tx_pkt_split(const char *name);
661 void set_nb_pkt_per_burst(uint16_t pkt_burst);
662 char *list_pkt_forwarding_modes(void);
663 char *list_pkt_forwarding_retry_modes(void);
664 void set_pkt_forwarding_mode(const char *fwd_mode);
665 void start_packet_forwarding(int with_tx_first);
666 void stop_packet_forwarding(void);
667 void dev_set_link_up(portid_t pid);
668 void dev_set_link_down(portid_t pid);
669 void init_port_config(void);
670 void set_port_slave_flag(portid_t slave_pid);
671 void clear_port_slave_flag(portid_t slave_pid);
672 uint8_t port_is_bonding_slave(portid_t slave_pid);
673
674 int init_port_dcb_config(portid_t pid, enum dcb_mode_enable dcb_mode,
675                      enum rte_eth_nb_tcs num_tcs,
676                      uint8_t pfc_en);
677 int start_port(portid_t pid);
678 void stop_port(portid_t pid);
679 void close_port(portid_t pid);
680 void reset_port(portid_t pid);
681 void attach_port(char *identifier);
682 void detach_port(portid_t port_id);
683 int all_ports_stopped(void);
684 int port_is_stopped(portid_t port_id);
685 int port_is_started(portid_t port_id);
686 void pmd_test_exit(void);
687 void fdir_get_infos(portid_t port_id);
688 void fdir_set_flex_mask(portid_t port_id,
689                            struct rte_eth_fdir_flex_mask *cfg);
690 void fdir_set_flex_payload(portid_t port_id,
691                            struct rte_eth_flex_payload_cfg *cfg);
692 void port_rss_reta_info(portid_t port_id,
693                         struct rte_eth_rss_reta_entry64 *reta_conf,
694                         uint16_t nb_entries);
695
696 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
697
698 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
699 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
700                                 uint64_t q_msk);
701
702 void port_rss_hash_conf_show(portid_t port_id, char rss_info[],
703                              int show_rss_key);
704 void port_rss_hash_key_update(portid_t port_id, char rss_type[],
705                               uint8_t *hash_key, uint hash_key_len);
706 int rx_queue_id_is_invalid(queueid_t rxq_id);
707 int tx_queue_id_is_invalid(queueid_t txq_id);
708 void setup_gro(const char *onoff, portid_t port_id);
709 void setup_gro_flush_cycles(uint8_t cycles);
710 void show_gro(portid_t port_id);
711 void setup_gso(const char *mode, portid_t port_id);
712
713 /* Functions to manage the set of filtered Multicast MAC addresses */
714 void mcast_addr_add(portid_t port_id, struct ether_addr *mc_addr);
715 void mcast_addr_remove(portid_t port_id, struct ether_addr *mc_addr);
716 void port_dcb_info_display(portid_t port_id);
717
718 uint8_t *open_file(const char *file_path, uint32_t *size);
719 int save_file(const char *file_path, uint8_t *buf, uint32_t size);
720 int close_file(uint8_t *buf);
721
722 void port_queue_region_info_display(portid_t port_id, void *buf);
723
724 enum print_warning {
725         ENABLED_WARN = 0,
726         DISABLED_WARN
727 };
728 int port_id_is_invalid(portid_t port_id, enum print_warning warning);
729 int new_socket_id(unsigned int socket_id);
730
731 queueid_t get_allowed_max_nb_rxq(portid_t *pid);
732 int check_nb_rxq(queueid_t rxq);
733 queueid_t get_allowed_max_nb_txq(portid_t *pid);
734 int check_nb_txq(queueid_t txq);
735
736 /*
737  * Work-around of a compilation error with ICC on invocations of the
738  * rte_be_to_cpu_16() function.
739  */
740 #ifdef __GCC__
741 #define RTE_BE_TO_CPU_16(be_16_v)  rte_be_to_cpu_16((be_16_v))
742 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
743 #else
744 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
745 #define RTE_BE_TO_CPU_16(be_16_v)  (be_16_v)
746 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
747 #else
748 #define RTE_BE_TO_CPU_16(be_16_v) \
749         (uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
750 #define RTE_CPU_TO_BE_16(cpu_16_v) \
751         (uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
752 #endif
753 #endif /* __GCC__ */
754
755 #define TESTPMD_LOG(level, fmt, args...) \
756         rte_log(RTE_LOG_ ## level, testpmd_logtype, "testpmd: " fmt, ## args)
757
758 #endif /* _TESTPMD_H_ */