9ccfb6d00fc8aac92c7ff0d326695ded2d4a588f
[dpdk.git] / app / test-pmd / testpmd.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2017 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef _TESTPMD_H_
35 #define _TESTPMD_H_
36
37 #include <rte_pci.h>
38
39 #define RTE_PORT_ALL            (~(portid_t)0x0)
40
41 #define RTE_TEST_RX_DESC_MAX    2048
42 #define RTE_TEST_TX_DESC_MAX    2048
43
44 #define RTE_PORT_STOPPED        (uint16_t)0
45 #define RTE_PORT_STARTED        (uint16_t)1
46 #define RTE_PORT_CLOSED         (uint16_t)2
47 #define RTE_PORT_HANDLING       (uint16_t)3
48
49 /*
50  * It is used to allocate the memory for hash key.
51  * The hash key size is NIC dependent.
52  */
53 #define RSS_HASH_KEY_LENGTH 64
54
55 /*
56  * Default size of the mbuf data buffer to receive standard 1518-byte
57  * Ethernet frames in a mono-segment memory buffer.
58  */
59 #define DEFAULT_MBUF_DATA_SIZE RTE_MBUF_DEFAULT_BUF_SIZE
60 /**< Default size of mbuf data buffer. */
61
62 /*
63  * The maximum number of segments per packet is used when creating
64  * scattered transmit packets composed of a list of mbufs.
65  */
66 #define RTE_MAX_SEGS_PER_PKT 255 /**< nb_segs is a 8-bit unsigned char. */
67
68 #define MAX_PKT_BURST 512
69 #define DEF_PKT_BURST 32
70
71 #define DEF_MBUF_CACHE 250
72
73 #define RTE_CACHE_LINE_SIZE_ROUNDUP(size) \
74         (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
75
76 #define NUMA_NO_CONFIG 0xFF
77 #define UMA_NO_CONFIG  0xFF
78
79 typedef uint8_t  lcoreid_t;
80 typedef uint8_t  portid_t;
81 typedef uint16_t queueid_t;
82 typedef uint16_t streamid_t;
83
84 #define MAX_QUEUE_ID ((1 << (sizeof(queueid_t) * 8)) - 1)
85
86 enum {
87         PORT_TOPOLOGY_PAIRED,
88         PORT_TOPOLOGY_CHAINED,
89         PORT_TOPOLOGY_LOOP,
90 };
91
92 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
93 /**
94  * The data structure associated with RX and TX packet burst statistics
95  * that are recorded for each forwarding stream.
96  */
97 struct pkt_burst_stats {
98         unsigned int pkt_burst_spread[MAX_PKT_BURST];
99 };
100 #endif
101
102 /**
103  * The data structure associated with a forwarding stream between a receive
104  * port/queue and a transmit port/queue.
105  */
106 struct fwd_stream {
107         /* "read-only" data */
108         portid_t   rx_port;   /**< port to poll for received packets */
109         queueid_t  rx_queue;  /**< RX queue to poll on "rx_port" */
110         portid_t   tx_port;   /**< forwarding port of received packets */
111         queueid_t  tx_queue;  /**< TX queue to send forwarded packets */
112         streamid_t peer_addr; /**< index of peer ethernet address of packets */
113
114         unsigned int retry_enabled;
115
116         /* "read-write" results */
117         unsigned int rx_packets;  /**< received packets */
118         unsigned int tx_packets;  /**< received packets transmitted */
119         unsigned int fwd_dropped; /**< received packets not forwarded */
120         unsigned int rx_bad_ip_csum ; /**< received packets has bad ip checksum */
121         unsigned int rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
122 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
123         uint64_t     core_cycles; /**< used for RX and TX processing */
124 #endif
125 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
126         struct pkt_burst_stats rx_burst_stats;
127         struct pkt_burst_stats tx_burst_stats;
128 #endif
129 };
130
131 /** Offload IP checksum in csum forward engine */
132 #define TESTPMD_TX_OFFLOAD_IP_CKSUM          0x0001
133 /** Offload UDP checksum in csum forward engine */
134 #define TESTPMD_TX_OFFLOAD_UDP_CKSUM         0x0002
135 /** Offload TCP checksum in csum forward engine */
136 #define TESTPMD_TX_OFFLOAD_TCP_CKSUM         0x0004
137 /** Offload SCTP checksum in csum forward engine */
138 #define TESTPMD_TX_OFFLOAD_SCTP_CKSUM        0x0008
139 /** Offload outer IP checksum in csum forward engine for recognized tunnels */
140 #define TESTPMD_TX_OFFLOAD_OUTER_IP_CKSUM    0x0010
141 /** Parse tunnel in csum forward engine. If set, dissect tunnel headers
142  * of rx packets. If not set, treat inner headers as payload. */
143 #define TESTPMD_TX_OFFLOAD_PARSE_TUNNEL      0x0020
144 /** Insert VLAN header in forward engine */
145 #define TESTPMD_TX_OFFLOAD_INSERT_VLAN       0x0040
146 /** Insert double VLAN header in forward engine */
147 #define TESTPMD_TX_OFFLOAD_INSERT_QINQ       0x0080
148 /** Offload MACsec in forward engine */
149 #define TESTPMD_TX_OFFLOAD_MACSEC            0x0100
150
151 /** Descriptor for a single flow. */
152 struct port_flow {
153         size_t size; /**< Allocated space including data[]. */
154         struct port_flow *next; /**< Next flow in list. */
155         struct port_flow *tmp; /**< Temporary linking. */
156         uint32_t id; /**< Flow rule ID. */
157         struct rte_flow *flow; /**< Opaque flow object returned by PMD. */
158         struct rte_flow_attr attr; /**< Attributes. */
159         struct rte_flow_item *pattern; /**< Pattern. */
160         struct rte_flow_action *actions; /**< Actions. */
161         uint8_t data[]; /**< Storage for pattern/actions. */
162 };
163
164 /**
165  * The data structure associated with each port.
166  */
167 struct rte_port {
168         struct rte_eth_dev_info dev_info;   /**< PCI info + driver name */
169         struct rte_eth_conf     dev_conf;   /**< Port configuration. */
170         struct ether_addr       eth_addr;   /**< Port ethernet address */
171         struct rte_eth_stats    stats;      /**< Last port statistics */
172         uint64_t                tx_dropped; /**< If no descriptor in TX ring */
173         struct fwd_stream       *rx_stream; /**< Port RX stream, if unique */
174         struct fwd_stream       *tx_stream; /**< Port TX stream, if unique */
175         unsigned int            socket_id;  /**< For NUMA support */
176         uint16_t                tx_ol_flags;/**< TX Offload Flags (TESTPMD_TX_OFFLOAD...). */
177         uint16_t                tso_segsz;  /**< Segmentation offload MSS for non-tunneled packets. */
178         uint16_t                tunnel_tso_segsz; /**< Segmentation offload MSS for tunneled pkts. */
179         uint16_t                tx_vlan_id;/**< The tag ID */
180         uint16_t                tx_vlan_id_outer;/**< The outer tag ID */
181         void                    *fwd_ctx;   /**< Forwarding mode context */
182         uint64_t                rx_bad_ip_csum; /**< rx pkts with bad ip checksum  */
183         uint64_t                rx_bad_l4_csum; /**< rx pkts with bad l4 checksum */
184         uint8_t                 tx_queue_stats_mapping_enabled;
185         uint8_t                 rx_queue_stats_mapping_enabled;
186         volatile uint16_t        port_status;    /**< port started or not */
187         uint8_t                 need_reconfig;  /**< need reconfiguring port or not */
188         uint8_t                 need_reconfig_queues; /**< need reconfiguring queues or not */
189         uint8_t                 rss_flag;   /**< enable rss or not */
190         uint8_t                 dcb_flag;   /**< enable dcb */
191         struct rte_eth_rxconf   rx_conf;    /**< rx configuration */
192         struct rte_eth_txconf   tx_conf;    /**< tx configuration */
193         struct ether_addr       *mc_addr_pool; /**< pool of multicast addrs */
194         uint32_t                mc_addr_nb; /**< nb. of addr. in mc_addr_pool */
195         uint8_t                 slave_flag; /**< bonding slave port */
196         struct port_flow        *flow_list; /**< Associated flows. */
197 };
198
199 /**
200  * The data structure associated with each forwarding logical core.
201  * The logical cores are internally numbered by a core index from 0 to
202  * the maximum number of logical cores - 1.
203  * The system CPU identifier of all logical cores are setup in a global
204  * CPU id. configuration table.
205  */
206 struct fwd_lcore {
207         struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
208         streamid_t stream_idx;   /**< index of 1st stream in "fwd_streams" */
209         streamid_t stream_nb;    /**< number of streams in "fwd_streams" */
210         lcoreid_t  cpuid_idx;    /**< index of logical core in CPU id table */
211         queueid_t  tx_queue;     /**< TX queue to send forwarded packets */
212         volatile char stopped;   /**< stop forwarding when set */
213 };
214
215 /*
216  * Forwarding mode operations:
217  *   - IO forwarding mode (default mode)
218  *     Forwards packets unchanged.
219  *
220  *   - MAC forwarding mode
221  *     Set the source and the destination Ethernet addresses of packets
222  *     before forwarding them.
223  *
224  *   - IEEE1588 forwarding mode
225  *     Check that received IEEE1588 Precise Time Protocol (PTP) packets are
226  *     filtered and timestamped by the hardware.
227  *     Forwards packets unchanged on the same port.
228  *     Check that sent IEEE1588 PTP packets are timestamped by the hardware.
229  */
230 typedef void (*port_fwd_begin_t)(portid_t pi);
231 typedef void (*port_fwd_end_t)(portid_t pi);
232 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
233
234 struct fwd_engine {
235         const char       *fwd_mode_name; /**< Forwarding mode name. */
236         port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
237         port_fwd_end_t   port_fwd_end;   /**< NULL if nothing special to do. */
238         packet_fwd_t     packet_fwd;     /**< Mandatory. */
239 };
240
241 #define BURST_TX_WAIT_US 1
242 #define BURST_TX_RETRIES 64
243
244 extern uint32_t burst_tx_delay_time;
245 extern uint32_t burst_tx_retry_num;
246
247 extern struct fwd_engine io_fwd_engine;
248 extern struct fwd_engine mac_fwd_engine;
249 extern struct fwd_engine mac_swap_engine;
250 extern struct fwd_engine flow_gen_engine;
251 extern struct fwd_engine rx_only_engine;
252 extern struct fwd_engine tx_only_engine;
253 extern struct fwd_engine csum_fwd_engine;
254 extern struct fwd_engine icmp_echo_engine;
255 #ifdef RTE_LIBRTE_IEEE1588
256 extern struct fwd_engine ieee1588_fwd_engine;
257 #endif
258
259 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
260
261 /**
262  * Forwarding Configuration
263  *
264  */
265 struct fwd_config {
266         struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
267         streamid_t nb_fwd_streams;  /**< Nb. of forward streams to process. */
268         lcoreid_t  nb_fwd_lcores;   /**< Nb. of logical cores to launch. */
269         portid_t   nb_fwd_ports;    /**< Nb. of ports involved. */
270 };
271
272 /**
273  * DCB mode enable
274  */
275 enum dcb_mode_enable
276 {
277         DCB_VT_ENABLED,
278         DCB_ENABLED
279 };
280
281 #define MAX_TX_QUEUE_STATS_MAPPINGS 1024 /* MAX_PORT of 32 @ 32 tx_queues/port */
282 #define MAX_RX_QUEUE_STATS_MAPPINGS 4096 /* MAX_PORT of 32 @ 128 rx_queues/port */
283
284 struct queue_stats_mappings {
285         uint8_t port_id;
286         uint16_t queue_id;
287         uint8_t stats_counter_id;
288 } __rte_cache_aligned;
289
290 extern struct queue_stats_mappings tx_queue_stats_mappings_array[];
291 extern struct queue_stats_mappings rx_queue_stats_mappings_array[];
292
293 /* Assign both tx and rx queue stats mappings to the same default values */
294 extern struct queue_stats_mappings *tx_queue_stats_mappings;
295 extern struct queue_stats_mappings *rx_queue_stats_mappings;
296
297 extern uint16_t nb_tx_queue_stats_mappings;
298 extern uint16_t nb_rx_queue_stats_mappings;
299
300 /* globals used for configuration */
301 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
302 extern uint8_t  interactive;
303 extern uint8_t  auto_start;
304 extern uint8_t  tx_first;
305 extern char cmdline_filename[PATH_MAX]; /**< offline commands file */
306 extern uint8_t  numa_support; /**< set by "--numa" parameter */
307 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
308 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
309 extern uint8_t  mp_anon; /**< set by "--mp-anon" parameter */
310 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
311 extern volatile int test_done; /* stop packet forwarding when set to 1. */
312 extern uint8_t lsc_interrupt; /**< disabled by "--no-lsc-interrupt" parameter */
313 extern uint8_t rmv_interrupt; /**< disabled by "--no-rmv-interrupt" parameter */
314 extern uint32_t event_print_mask;
315 /**< set by "--print-event xxxx" and "--mask-event xxxx parameters */
316
317 #ifdef RTE_LIBRTE_IXGBE_BYPASS
318 extern uint32_t bypass_timeout; /**< Store the NIC bypass watchdog timeout */
319 #endif
320
321 /*
322  * Store specified sockets on which memory pool to be used by ports
323  * is allocated.
324  */
325 uint8_t port_numa[RTE_MAX_ETHPORTS];
326
327 /*
328  * Store specified sockets on which RX ring to be used by ports
329  * is allocated.
330  */
331 uint8_t rxring_numa[RTE_MAX_ETHPORTS];
332
333 /*
334  * Store specified sockets on which TX ring to be used by ports
335  * is allocated.
336  */
337 uint8_t txring_numa[RTE_MAX_ETHPORTS];
338
339 extern uint8_t socket_num;
340
341 /*
342  * Configuration of logical cores:
343  * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
344  */
345 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
346 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
347 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
348 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
349 extern unsigned int num_sockets;
350 extern unsigned int socket_ids[RTE_MAX_NUMA_NODES];
351
352 /*
353  * Configuration of Ethernet ports:
354  * nb_fwd_ports <= nb_cfg_ports <= nb_ports
355  */
356 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
357 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
358 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
359 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
360 extern struct rte_port *ports;
361
362 extern struct rte_eth_rxmode rx_mode;
363 extern uint64_t rss_hf;
364
365 extern queueid_t nb_rxq;
366 extern queueid_t nb_txq;
367
368 extern uint16_t nb_rxd;
369 extern uint16_t nb_txd;
370
371 extern int16_t rx_free_thresh;
372 extern int8_t rx_drop_en;
373 extern int16_t tx_free_thresh;
374 extern int16_t tx_rs_thresh;
375 extern int32_t txq_flags;
376
377 extern uint8_t dcb_config;
378 extern uint8_t dcb_test;
379 extern enum dcb_queue_mapping_mode dcb_q_mapping;
380
381 extern uint16_t mbuf_data_size; /**< Mbuf data space size. */
382 extern uint32_t param_total_num_mbufs;
383
384 extern uint16_t stats_period;
385
386 #ifdef RTE_LIBRTE_LATENCY_STATS
387 extern uint8_t latencystats_enabled;
388 extern lcoreid_t latencystats_lcore_id;
389 #endif
390
391 #ifdef RTE_LIBRTE_BITRATE
392 extern lcoreid_t bitrate_lcore_id;
393 extern uint8_t bitrate_enabled;
394 #endif
395
396 extern struct rte_fdir_conf fdir_conf;
397
398 /*
399  * Configuration of packet segments used by the "txonly" processing engine.
400  */
401 #define TXONLY_DEF_PACKET_LEN 64
402 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
403 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
404 extern uint8_t  tx_pkt_nb_segs; /**< Number of segments in TX packets */
405
406 enum tx_pkt_split {
407         TX_PKT_SPLIT_OFF,
408         TX_PKT_SPLIT_ON,
409         TX_PKT_SPLIT_RND,
410 };
411
412 extern enum tx_pkt_split tx_pkt_split;
413
414 extern uint16_t nb_pkt_per_burst;
415 extern uint16_t mb_mempool_cache;
416 extern int8_t rx_pthresh;
417 extern int8_t rx_hthresh;
418 extern int8_t rx_wthresh;
419 extern int8_t tx_pthresh;
420 extern int8_t tx_hthresh;
421 extern int8_t tx_wthresh;
422
423 extern struct fwd_config cur_fwd_config;
424 extern struct fwd_engine *cur_fwd_eng;
425 extern uint32_t retry_enabled;
426 extern struct fwd_lcore  **fwd_lcores;
427 extern struct fwd_stream **fwd_streams;
428
429 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
430 extern struct ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
431
432 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
433 extern uint32_t burst_tx_retry_num;  /**< Burst tx retry number for mac-retry. */
434
435 static inline unsigned int
436 lcore_num(void)
437 {
438         unsigned int i;
439
440         for (i = 0; i < RTE_MAX_LCORE; ++i)
441                 if (fwd_lcores_cpuids[i] == rte_lcore_id())
442                         return i;
443
444         rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
445 }
446
447 static inline struct fwd_lcore *
448 current_fwd_lcore(void)
449 {
450         return fwd_lcores[lcore_num()];
451 }
452
453 /* Mbuf Pools */
454 static inline void
455 mbuf_poolname_build(unsigned int sock_id, char* mp_name, int name_size)
456 {
457         snprintf(mp_name, name_size, "mbuf_pool_socket_%u", sock_id);
458 }
459
460 static inline struct rte_mempool *
461 mbuf_pool_find(unsigned int sock_id)
462 {
463         char pool_name[RTE_MEMPOOL_NAMESIZE];
464
465         mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name));
466         return rte_mempool_lookup((const char *)pool_name);
467 }
468
469 /**
470  * Read/Write operations on a PCI register of a port.
471  */
472 static inline uint32_t
473 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
474 {
475         void *reg_addr;
476         uint32_t reg_v;
477
478         reg_addr = (void *)
479                 ((char *)port->dev_info.pci_dev->mem_resource[0].addr +
480                         reg_off);
481         reg_v = *((volatile uint32_t *)reg_addr);
482         return rte_le_to_cpu_32(reg_v);
483 }
484
485 #define port_id_pci_reg_read(pt_id, reg_off) \
486         port_pci_reg_read(&ports[(pt_id)], (reg_off))
487
488 static inline void
489 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
490 {
491         void *reg_addr;
492
493         reg_addr = (void *)
494                 ((char *)port->dev_info.pci_dev->mem_resource[0].addr +
495                         reg_off);
496         *((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
497 }
498
499 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
500         port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
501
502 /* Prototypes */
503 unsigned int parse_item_list(char* str, const char* item_name,
504                         unsigned int max_items,
505                         unsigned int *parsed_items, int check_unique_values);
506 void launch_args_parse(int argc, char** argv);
507 void cmdline_read_from_file(const char *filename);
508 void prompt(void);
509 void prompt_exit(void);
510 void nic_stats_display(portid_t port_id);
511 void nic_stats_clear(portid_t port_id);
512 void nic_xstats_display(portid_t port_id);
513 void nic_xstats_clear(portid_t port_id);
514 void nic_stats_mapping_display(portid_t port_id);
515 void port_infos_display(portid_t port_id);
516 void port_offload_cap_display(portid_t port_id);
517 void rx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
518 void tx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
519 void fwd_lcores_config_display(void);
520 void pkt_fwd_config_display(struct fwd_config *cfg);
521 void rxtx_config_display(void);
522 void fwd_config_setup(void);
523 void set_def_fwd_config(void);
524 void reconfig(portid_t new_port_id, unsigned socket_id);
525 int init_fwd_streams(void);
526
527 void port_mtu_set(portid_t port_id, uint16_t mtu);
528 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
529 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
530                       uint8_t bit_v);
531 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
532                                 uint8_t bit1_pos, uint8_t bit2_pos);
533 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
534                             uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
535 void port_reg_display(portid_t port_id, uint32_t reg_off);
536 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
537 int port_flow_validate(portid_t port_id,
538                        const struct rte_flow_attr *attr,
539                        const struct rte_flow_item *pattern,
540                        const struct rte_flow_action *actions);
541 int port_flow_create(portid_t port_id,
542                      const struct rte_flow_attr *attr,
543                      const struct rte_flow_item *pattern,
544                      const struct rte_flow_action *actions);
545 int port_flow_destroy(portid_t port_id, uint32_t n, const uint32_t *rule);
546 int port_flow_flush(portid_t port_id);
547 int port_flow_query(portid_t port_id, uint32_t rule,
548                     enum rte_flow_action_type action);
549 void port_flow_list(portid_t port_id, uint32_t n, const uint32_t *group);
550 int port_flow_isolate(portid_t port_id, int set);
551
552 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
553 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
554
555 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
556 int set_fwd_lcores_mask(uint64_t lcoremask);
557 void set_fwd_lcores_number(uint16_t nb_lc);
558
559 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
560 void set_fwd_ports_mask(uint64_t portmask);
561 void set_fwd_ports_number(uint16_t nb_pt);
562 int port_is_forwarding(portid_t port_id);
563
564 void rx_vlan_strip_set(portid_t port_id, int on);
565 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
566
567 void rx_vlan_filter_set(portid_t port_id, int on);
568 void rx_vlan_all_filter_set(portid_t port_id, int on);
569 int rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
570 void vlan_extend_set(portid_t port_id, int on);
571 void vlan_tpid_set(portid_t port_id, enum rte_vlan_type vlan_type,
572                    uint16_t tp_id);
573 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
574 void tx_qinq_set(portid_t port_id, uint16_t vlan_id, uint16_t vlan_id_outer);
575 void tx_vlan_reset(portid_t port_id);
576 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
577
578 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
579
580 void set_verbose_level(uint16_t vb_level);
581 void set_tx_pkt_segments(unsigned *seg_lengths, unsigned nb_segs);
582 void show_tx_pkt_segments(void);
583 void set_tx_pkt_split(const char *name);
584 void set_nb_pkt_per_burst(uint16_t pkt_burst);
585 char *list_pkt_forwarding_modes(void);
586 char *list_pkt_forwarding_retry_modes(void);
587 void set_pkt_forwarding_mode(const char *fwd_mode);
588 void start_packet_forwarding(int with_tx_first);
589 void stop_packet_forwarding(void);
590 void dev_set_link_up(portid_t pid);
591 void dev_set_link_down(portid_t pid);
592 void init_port_config(void);
593 void set_port_slave_flag(portid_t slave_pid);
594 void clear_port_slave_flag(portid_t slave_pid);
595 uint8_t port_is_bonding_slave(portid_t slave_pid);
596
597 int init_port_dcb_config(portid_t pid, enum dcb_mode_enable dcb_mode,
598                      enum rte_eth_nb_tcs num_tcs,
599                      uint8_t pfc_en);
600 int start_port(portid_t pid);
601 void stop_port(portid_t pid);
602 void close_port(portid_t pid);
603 void attach_port(char *identifier);
604 void detach_port(uint8_t port_id);
605 int all_ports_stopped(void);
606 int port_is_started(portid_t port_id);
607 void pmd_test_exit(void);
608 void fdir_get_infos(portid_t port_id);
609 void fdir_set_flex_mask(portid_t port_id,
610                            struct rte_eth_fdir_flex_mask *cfg);
611 void fdir_set_flex_payload(portid_t port_id,
612                            struct rte_eth_flex_payload_cfg *cfg);
613 void port_rss_reta_info(portid_t port_id,
614                         struct rte_eth_rss_reta_entry64 *reta_conf,
615                         uint16_t nb_entries);
616
617 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
618
619 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
620 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
621                                 uint64_t q_msk);
622
623 void port_rss_hash_conf_show(portid_t port_id, char rss_info[],
624                              int show_rss_key);
625 void port_rss_hash_key_update(portid_t port_id, char rss_type[],
626                               uint8_t *hash_key, uint hash_key_len);
627 void get_syn_filter(uint8_t port_id);
628 void get_ethertype_filter(uint8_t port_id, uint16_t index);
629 void get_2tuple_filter(uint8_t port_id, uint16_t index);
630 void get_5tuple_filter(uint8_t port_id, uint16_t index);
631 int rx_queue_id_is_invalid(queueid_t rxq_id);
632 int tx_queue_id_is_invalid(queueid_t txq_id);
633
634 /* Functions to manage the set of filtered Multicast MAC addresses */
635 void mcast_addr_add(uint8_t port_id, struct ether_addr *mc_addr);
636 void mcast_addr_remove(uint8_t port_id, struct ether_addr *mc_addr);
637 void port_dcb_info_display(uint8_t port_id);
638
639 uint8_t *open_ddp_package_file(const char *file_path, uint32_t *size);
640 int save_ddp_package_file(const char *file_path, uint8_t *buf, uint32_t size);
641 int close_ddp_package_file(uint8_t *buf);
642
643 enum print_warning {
644         ENABLED_WARN = 0,
645         DISABLED_WARN
646 };
647 int port_id_is_invalid(portid_t port_id, enum print_warning warning);
648 int new_socket_id(unsigned int socket_id);
649
650 /*
651  * Work-around of a compilation error with ICC on invocations of the
652  * rte_be_to_cpu_16() function.
653  */
654 #ifdef __GCC__
655 #define RTE_BE_TO_CPU_16(be_16_v)  rte_be_to_cpu_16((be_16_v))
656 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
657 #else
658 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
659 #define RTE_BE_TO_CPU_16(be_16_v)  (be_16_v)
660 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
661 #else
662 #define RTE_BE_TO_CPU_16(be_16_v) \
663         (uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
664 #define RTE_CPU_TO_BE_16(cpu_16_v) \
665         (uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
666 #endif
667 #endif /* __GCC__ */
668
669 #endif /* _TESTPMD_H_ */