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