xref: /dpdk/app/test-pmd/testpmd.h (revision 0a081a5fd26fbdae00a34541924d798b6dd4a63e)
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 #include <rte_gro.h>
39 #include <rte_gso.h>
40 
41 #define RTE_PORT_ALL            (~(portid_t)0x0)
42 
43 #define RTE_TEST_RX_DESC_MAX    2048
44 #define RTE_TEST_TX_DESC_MAX    2048
45 
46 #define RTE_PORT_STOPPED        (uint16_t)0
47 #define RTE_PORT_STARTED        (uint16_t)1
48 #define RTE_PORT_CLOSED         (uint16_t)2
49 #define RTE_PORT_HANDLING       (uint16_t)3
50 
51 /*
52  * It is used to allocate the memory for hash key.
53  * The hash key size is NIC dependent.
54  */
55 #define RSS_HASH_KEY_LENGTH 64
56 
57 /*
58  * Default size of the mbuf data buffer to receive standard 1518-byte
59  * Ethernet frames in a mono-segment memory buffer.
60  */
61 #define DEFAULT_MBUF_DATA_SIZE RTE_MBUF_DEFAULT_BUF_SIZE
62 /**< Default size of mbuf data buffer. */
63 
64 /*
65  * The maximum number of segments per packet is used when creating
66  * scattered transmit packets composed of a list of mbufs.
67  */
68 #define RTE_MAX_SEGS_PER_PKT 255 /**< nb_segs is a 8-bit unsigned char. */
69 
70 #define MAX_PKT_BURST 512
71 #define DEF_PKT_BURST 32
72 
73 #define DEF_MBUF_CACHE 250
74 
75 #define RTE_CACHE_LINE_SIZE_ROUNDUP(size) \
76 	(RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
77 
78 #define NUMA_NO_CONFIG 0xFF
79 #define UMA_NO_CONFIG  0xFF
80 
81 typedef uint8_t  lcoreid_t;
82 typedef uint16_t portid_t;
83 typedef uint16_t queueid_t;
84 typedef uint16_t streamid_t;
85 
86 #define MAX_QUEUE_ID ((1 << (sizeof(queueid_t) * 8)) - 1)
87 
88 #if defined RTE_LIBRTE_PMD_SOFTNIC && defined RTE_LIBRTE_SCHED
89 #define TM_MODE			1
90 #else
91 #define TM_MODE			0
92 #endif
93 
94 enum {
95 	PORT_TOPOLOGY_PAIRED,
96 	PORT_TOPOLOGY_CHAINED,
97 	PORT_TOPOLOGY_LOOP,
98 };
99 
100 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
101 /**
102  * The data structure associated with RX and TX packet burst statistics
103  * that are recorded for each forwarding stream.
104  */
105 struct pkt_burst_stats {
106 	unsigned int pkt_burst_spread[MAX_PKT_BURST];
107 };
108 #endif
109 
110 /**
111  * The data structure associated with a forwarding stream between a receive
112  * port/queue and a transmit port/queue.
113  */
114 struct fwd_stream {
115 	/* "read-only" data */
116 	portid_t   rx_port;   /**< port to poll for received packets */
117 	queueid_t  rx_queue;  /**< RX queue to poll on "rx_port" */
118 	portid_t   tx_port;   /**< forwarding port of received packets */
119 	queueid_t  tx_queue;  /**< TX queue to send forwarded packets */
120 	streamid_t peer_addr; /**< index of peer ethernet address of packets */
121 
122 	unsigned int retry_enabled;
123 
124 	/* "read-write" results */
125 	unsigned int rx_packets;  /**< received packets */
126 	unsigned int tx_packets;  /**< received packets transmitted */
127 	unsigned int fwd_dropped; /**< received packets not forwarded */
128 	unsigned int rx_bad_ip_csum ; /**< received packets has bad ip checksum */
129 	unsigned int rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
130 	unsigned int gro_times;	/**< GRO operation times */
131 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
132 	uint64_t     core_cycles; /**< used for RX and TX processing */
133 #endif
134 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
135 	struct pkt_burst_stats rx_burst_stats;
136 	struct pkt_burst_stats tx_burst_stats;
137 #endif
138 };
139 
140 /** Offload IP checksum in csum forward engine */
141 #define TESTPMD_TX_OFFLOAD_IP_CKSUM          0x0001
142 /** Offload UDP checksum in csum forward engine */
143 #define TESTPMD_TX_OFFLOAD_UDP_CKSUM         0x0002
144 /** Offload TCP checksum in csum forward engine */
145 #define TESTPMD_TX_OFFLOAD_TCP_CKSUM         0x0004
146 /** Offload SCTP checksum in csum forward engine */
147 #define TESTPMD_TX_OFFLOAD_SCTP_CKSUM        0x0008
148 /** Offload outer IP checksum in csum forward engine for recognized tunnels */
149 #define TESTPMD_TX_OFFLOAD_OUTER_IP_CKSUM    0x0010
150 /** Parse tunnel in csum forward engine. If set, dissect tunnel headers
151  * of rx packets. If not set, treat inner headers as payload. */
152 #define TESTPMD_TX_OFFLOAD_PARSE_TUNNEL      0x0020
153 /** Insert VLAN header in forward engine */
154 #define TESTPMD_TX_OFFLOAD_INSERT_VLAN       0x0040
155 /** Insert double VLAN header in forward engine */
156 #define TESTPMD_TX_OFFLOAD_INSERT_QINQ       0x0080
157 /** Offload MACsec in forward engine */
158 #define TESTPMD_TX_OFFLOAD_MACSEC            0x0100
159 
160 /** Descriptor for a single flow. */
161 struct port_flow {
162 	size_t size; /**< Allocated space including data[]. */
163 	struct port_flow *next; /**< Next flow in list. */
164 	struct port_flow *tmp; /**< Temporary linking. */
165 	uint32_t id; /**< Flow rule ID. */
166 	struct rte_flow *flow; /**< Opaque flow object returned by PMD. */
167 	struct rte_flow_attr attr; /**< Attributes. */
168 	struct rte_flow_item *pattern; /**< Pattern. */
169 	struct rte_flow_action *actions; /**< Actions. */
170 	uint8_t data[]; /**< Storage for pattern/actions. */
171 };
172 
173 #ifdef TM_MODE
174 /**
175  * Soft port tm related parameters
176  */
177 struct softnic_port_tm {
178 	uint32_t default_hierarchy_enable; /**< def hierarchy enable flag */
179 	uint32_t hierarchy_config;  /**< set to 1 if hierarchy configured */
180 
181 	uint32_t n_subports_per_port;  /**< Num of subport nodes per port */
182 	uint32_t n_pipes_per_subport;  /**< Num of pipe nodes per subport */
183 
184 	uint64_t tm_pktfield0_slabpos;	/**< Pkt field position for subport */
185 	uint64_t tm_pktfield0_slabmask; /**< Pkt field mask for the subport */
186 	uint64_t tm_pktfield0_slabshr;
187 	uint64_t tm_pktfield1_slabpos; /**< Pkt field position for the pipe */
188 	uint64_t tm_pktfield1_slabmask; /**< Pkt field mask for the pipe */
189 	uint64_t tm_pktfield1_slabshr;
190 	uint64_t tm_pktfield2_slabpos; /**< Pkt field position table index */
191 	uint64_t tm_pktfield2_slabmask;	/**< Pkt field mask for tc table idx */
192 	uint64_t tm_pktfield2_slabshr;
193 	uint64_t tm_tc_table[64];  /**< TC translation table */
194 };
195 
196 /**
197  * The data structure associate with softnic port
198  */
199 struct softnic_port {
200 	unsigned int tm_flag;	/**< set to 1 if tm feature is enabled */
201 	struct softnic_port_tm tm;	/**< softnic port tm parameters */
202 };
203 #endif
204 
205 /**
206  * The data structure associated with each port.
207  */
208 struct rte_port {
209 	struct rte_eth_dev_info dev_info;   /**< PCI info + driver name */
210 	struct rte_eth_conf     dev_conf;   /**< Port configuration. */
211 	struct ether_addr       eth_addr;   /**< Port ethernet address */
212 	struct rte_eth_stats    stats;      /**< Last port statistics */
213 	uint64_t                tx_dropped; /**< If no descriptor in TX ring */
214 	struct fwd_stream       *rx_stream; /**< Port RX stream, if unique */
215 	struct fwd_stream       *tx_stream; /**< Port TX stream, if unique */
216 	unsigned int            socket_id;  /**< For NUMA support */
217 	uint16_t                tx_ol_flags;/**< TX Offload Flags (TESTPMD_TX_OFFLOAD...). */
218 	uint16_t                tso_segsz;  /**< Segmentation offload MSS for non-tunneled packets. */
219 	uint16_t                tunnel_tso_segsz; /**< Segmentation offload MSS for tunneled pkts. */
220 	uint16_t                tx_vlan_id;/**< The tag ID */
221 	uint16_t                tx_vlan_id_outer;/**< The outer tag ID */
222 	void                    *fwd_ctx;   /**< Forwarding mode context */
223 	uint64_t                rx_bad_ip_csum; /**< rx pkts with bad ip checksum  */
224 	uint64_t                rx_bad_l4_csum; /**< rx pkts with bad l4 checksum */
225 	uint8_t                 tx_queue_stats_mapping_enabled;
226 	uint8_t                 rx_queue_stats_mapping_enabled;
227 	volatile uint16_t        port_status;    /**< port started or not */
228 	uint8_t                 need_reconfig;  /**< need reconfiguring port or not */
229 	uint8_t                 need_reconfig_queues; /**< need reconfiguring queues or not */
230 	uint8_t                 rss_flag;   /**< enable rss or not */
231 	uint8_t                 dcb_flag;   /**< enable dcb */
232 	struct rte_eth_rxconf   rx_conf;    /**< rx configuration */
233 	struct rte_eth_txconf   tx_conf;    /**< tx configuration */
234 	struct ether_addr       *mc_addr_pool; /**< pool of multicast addrs */
235 	uint32_t                mc_addr_nb; /**< nb. of addr. in mc_addr_pool */
236 	uint8_t                 slave_flag; /**< bonding slave port */
237 	struct port_flow        *flow_list; /**< Associated flows. */
238 #ifdef TM_MODE
239 	unsigned int			softnic_enable;	/**< softnic flag */
240 	struct softnic_port     softport;  /**< softnic port params */
241 #endif
242 };
243 
244 /**
245  * The data structure associated with each forwarding logical core.
246  * The logical cores are internally numbered by a core index from 0 to
247  * the maximum number of logical cores - 1.
248  * The system CPU identifier of all logical cores are setup in a global
249  * CPU id. configuration table.
250  */
251 struct fwd_lcore {
252 	struct rte_gso_ctx gso_ctx;     /**< GSO context */
253 	struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
254 	void *gro_ctx;		/**< GRO context */
255 	streamid_t stream_idx;   /**< index of 1st stream in "fwd_streams" */
256 	streamid_t stream_nb;    /**< number of streams in "fwd_streams" */
257 	lcoreid_t  cpuid_idx;    /**< index of logical core in CPU id table */
258 	queueid_t  tx_queue;     /**< TX queue to send forwarded packets */
259 	volatile char stopped;   /**< stop forwarding when set */
260 };
261 
262 /*
263  * Forwarding mode operations:
264  *   - IO forwarding mode (default mode)
265  *     Forwards packets unchanged.
266  *
267  *   - MAC forwarding mode
268  *     Set the source and the destination Ethernet addresses of packets
269  *     before forwarding them.
270  *
271  *   - IEEE1588 forwarding mode
272  *     Check that received IEEE1588 Precise Time Protocol (PTP) packets are
273  *     filtered and timestamped by the hardware.
274  *     Forwards packets unchanged on the same port.
275  *     Check that sent IEEE1588 PTP packets are timestamped by the hardware.
276  */
277 typedef void (*port_fwd_begin_t)(portid_t pi);
278 typedef void (*port_fwd_end_t)(portid_t pi);
279 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
280 
281 struct fwd_engine {
282 	const char       *fwd_mode_name; /**< Forwarding mode name. */
283 	port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
284 	port_fwd_end_t   port_fwd_end;   /**< NULL if nothing special to do. */
285 	packet_fwd_t     packet_fwd;     /**< Mandatory. */
286 };
287 
288 #define BURST_TX_WAIT_US 1
289 #define BURST_TX_RETRIES 64
290 
291 extern uint32_t burst_tx_delay_time;
292 extern uint32_t burst_tx_retry_num;
293 
294 extern struct fwd_engine io_fwd_engine;
295 extern struct fwd_engine mac_fwd_engine;
296 extern struct fwd_engine mac_swap_engine;
297 extern struct fwd_engine flow_gen_engine;
298 extern struct fwd_engine rx_only_engine;
299 extern struct fwd_engine tx_only_engine;
300 extern struct fwd_engine csum_fwd_engine;
301 extern struct fwd_engine icmp_echo_engine;
302 #ifdef TM_MODE
303 extern struct fwd_engine softnic_tm_engine;
304 extern struct fwd_engine softnic_tm_bypass_engine;
305 #endif
306 #ifdef RTE_LIBRTE_IEEE1588
307 extern struct fwd_engine ieee1588_fwd_engine;
308 #endif
309 
310 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
311 
312 /**
313  * Forwarding Configuration
314  *
315  */
316 struct fwd_config {
317 	struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
318 	streamid_t nb_fwd_streams;  /**< Nb. of forward streams to process. */
319 	lcoreid_t  nb_fwd_lcores;   /**< Nb. of logical cores to launch. */
320 	portid_t   nb_fwd_ports;    /**< Nb. of ports involved. */
321 };
322 
323 /**
324  * DCB mode enable
325  */
326 enum dcb_mode_enable
327 {
328 	DCB_VT_ENABLED,
329 	DCB_ENABLED
330 };
331 
332 #define MAX_TX_QUEUE_STATS_MAPPINGS 1024 /* MAX_PORT of 32 @ 32 tx_queues/port */
333 #define MAX_RX_QUEUE_STATS_MAPPINGS 4096 /* MAX_PORT of 32 @ 128 rx_queues/port */
334 
335 struct queue_stats_mappings {
336 	portid_t port_id;
337 	uint16_t queue_id;
338 	uint8_t stats_counter_id;
339 } __rte_cache_aligned;
340 
341 extern struct queue_stats_mappings tx_queue_stats_mappings_array[];
342 extern struct queue_stats_mappings rx_queue_stats_mappings_array[];
343 
344 /* Assign both tx and rx queue stats mappings to the same default values */
345 extern struct queue_stats_mappings *tx_queue_stats_mappings;
346 extern struct queue_stats_mappings *rx_queue_stats_mappings;
347 
348 extern uint16_t nb_tx_queue_stats_mappings;
349 extern uint16_t nb_rx_queue_stats_mappings;
350 
351 /* globals used for configuration */
352 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
353 extern uint8_t  interactive;
354 extern uint8_t  auto_start;
355 extern uint8_t  tx_first;
356 extern char cmdline_filename[PATH_MAX]; /**< offline commands file */
357 extern uint8_t  numa_support; /**< set by "--numa" parameter */
358 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
359 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
360 extern uint8_t flow_isolate_all; /**< set by "--flow-isolate-all */
361 extern uint8_t  mp_anon; /**< set by "--mp-anon" parameter */
362 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
363 extern volatile int test_done; /* stop packet forwarding when set to 1. */
364 extern uint8_t lsc_interrupt; /**< disabled by "--no-lsc-interrupt" parameter */
365 extern uint8_t rmv_interrupt; /**< disabled by "--no-rmv-interrupt" parameter */
366 extern uint32_t event_print_mask;
367 /**< set by "--print-event xxxx" and "--mask-event xxxx parameters */
368 
369 #ifdef RTE_LIBRTE_IXGBE_BYPASS
370 extern uint32_t bypass_timeout; /**< Store the NIC bypass watchdog timeout */
371 #endif
372 
373 /*
374  * Store specified sockets on which memory pool to be used by ports
375  * is allocated.
376  */
377 uint8_t port_numa[RTE_MAX_ETHPORTS];
378 
379 /*
380  * Store specified sockets on which RX ring to be used by ports
381  * is allocated.
382  */
383 uint8_t rxring_numa[RTE_MAX_ETHPORTS];
384 
385 /*
386  * Store specified sockets on which TX ring to be used by ports
387  * is allocated.
388  */
389 uint8_t txring_numa[RTE_MAX_ETHPORTS];
390 
391 extern uint8_t socket_num;
392 
393 /*
394  * Configuration of logical cores:
395  * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
396  */
397 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
398 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
399 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
400 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
401 extern unsigned int num_sockets;
402 extern unsigned int socket_ids[RTE_MAX_NUMA_NODES];
403 
404 /*
405  * Configuration of Ethernet ports:
406  * nb_fwd_ports <= nb_cfg_ports <= nb_ports
407  */
408 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
409 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
410 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
411 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
412 extern struct rte_port *ports;
413 
414 extern struct rte_eth_rxmode rx_mode;
415 extern uint64_t rss_hf;
416 
417 extern queueid_t nb_rxq;
418 extern queueid_t nb_txq;
419 
420 extern uint16_t nb_rxd;
421 extern uint16_t nb_txd;
422 
423 extern int16_t rx_free_thresh;
424 extern int8_t rx_drop_en;
425 extern int16_t tx_free_thresh;
426 extern int16_t tx_rs_thresh;
427 extern int32_t txq_flags;
428 
429 extern uint8_t dcb_config;
430 extern uint8_t dcb_test;
431 extern enum dcb_queue_mapping_mode dcb_q_mapping;
432 
433 extern uint16_t mbuf_data_size; /**< Mbuf data space size. */
434 extern uint32_t param_total_num_mbufs;
435 
436 extern uint16_t stats_period;
437 
438 #ifdef RTE_LIBRTE_LATENCY_STATS
439 extern uint8_t latencystats_enabled;
440 extern lcoreid_t latencystats_lcore_id;
441 #endif
442 
443 #ifdef RTE_LIBRTE_BITRATE
444 extern lcoreid_t bitrate_lcore_id;
445 extern uint8_t bitrate_enabled;
446 #endif
447 
448 extern struct rte_fdir_conf fdir_conf;
449 
450 /*
451  * Configuration of packet segments used by the "txonly" processing engine.
452  */
453 #define TXONLY_DEF_PACKET_LEN 64
454 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
455 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
456 extern uint8_t  tx_pkt_nb_segs; /**< Number of segments in TX packets */
457 
458 enum tx_pkt_split {
459 	TX_PKT_SPLIT_OFF,
460 	TX_PKT_SPLIT_ON,
461 	TX_PKT_SPLIT_RND,
462 };
463 
464 extern enum tx_pkt_split tx_pkt_split;
465 
466 extern uint16_t nb_pkt_per_burst;
467 extern uint16_t mb_mempool_cache;
468 extern int8_t rx_pthresh;
469 extern int8_t rx_hthresh;
470 extern int8_t rx_wthresh;
471 extern int8_t tx_pthresh;
472 extern int8_t tx_hthresh;
473 extern int8_t tx_wthresh;
474 
475 extern struct fwd_config cur_fwd_config;
476 extern struct fwd_engine *cur_fwd_eng;
477 extern uint32_t retry_enabled;
478 extern struct fwd_lcore  **fwd_lcores;
479 extern struct fwd_stream **fwd_streams;
480 
481 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
482 extern struct ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
483 
484 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
485 extern uint32_t burst_tx_retry_num;  /**< Burst tx retry number for mac-retry. */
486 
487 #define GRO_DEFAULT_ITEM_NUM_PER_FLOW 32
488 #define GRO_DEFAULT_FLOW_NUM (RTE_GRO_MAX_BURST_ITEM_NUM / \
489 		GRO_DEFAULT_ITEM_NUM_PER_FLOW)
490 
491 #define GRO_DEFAULT_FLUSH_CYCLES 1
492 #define GRO_MAX_FLUSH_CYCLES 4
493 
494 struct gro_status {
495 	struct rte_gro_param param;
496 	uint8_t enable;
497 };
498 extern struct gro_status gro_ports[RTE_MAX_ETHPORTS];
499 extern uint8_t gro_flush_cycles;
500 
501 #define GSO_MAX_PKT_BURST 2048
502 struct gso_status {
503 	uint8_t enable;
504 };
505 extern struct gso_status gso_ports[RTE_MAX_ETHPORTS];
506 extern uint16_t gso_max_segment_size;
507 
508 static inline unsigned int
509 lcore_num(void)
510 {
511 	unsigned int i;
512 
513 	for (i = 0; i < RTE_MAX_LCORE; ++i)
514 		if (fwd_lcores_cpuids[i] == rte_lcore_id())
515 			return i;
516 
517 	rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
518 }
519 
520 static inline struct fwd_lcore *
521 current_fwd_lcore(void)
522 {
523 	return fwd_lcores[lcore_num()];
524 }
525 
526 /* Mbuf Pools */
527 static inline void
528 mbuf_poolname_build(unsigned int sock_id, char* mp_name, int name_size)
529 {
530 	snprintf(mp_name, name_size, "mbuf_pool_socket_%u", sock_id);
531 }
532 
533 static inline struct rte_mempool *
534 mbuf_pool_find(unsigned int sock_id)
535 {
536 	char pool_name[RTE_MEMPOOL_NAMESIZE];
537 
538 	mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name));
539 	return rte_mempool_lookup((const char *)pool_name);
540 }
541 
542 /**
543  * Read/Write operations on a PCI register of a port.
544  */
545 static inline uint32_t
546 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
547 {
548 	void *reg_addr;
549 	uint32_t reg_v;
550 
551 	reg_addr = (void *)
552 		((char *)port->dev_info.pci_dev->mem_resource[0].addr +
553 			reg_off);
554 	reg_v = *((volatile uint32_t *)reg_addr);
555 	return rte_le_to_cpu_32(reg_v);
556 }
557 
558 #define port_id_pci_reg_read(pt_id, reg_off) \
559 	port_pci_reg_read(&ports[(pt_id)], (reg_off))
560 
561 static inline void
562 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
563 {
564 	void *reg_addr;
565 
566 	reg_addr = (void *)
567 		((char *)port->dev_info.pci_dev->mem_resource[0].addr +
568 			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 port_mtu_set(portid_t port_id, uint16_t mtu);
601 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
602 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
603 		      uint8_t bit_v);
604 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
605 				uint8_t bit1_pos, uint8_t bit2_pos);
606 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
607 			    uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
608 void port_reg_display(portid_t port_id, uint32_t reg_off);
609 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
610 int port_flow_validate(portid_t port_id,
611 		       const struct rte_flow_attr *attr,
612 		       const struct rte_flow_item *pattern,
613 		       const struct rte_flow_action *actions);
614 int port_flow_create(portid_t port_id,
615 		     const struct rte_flow_attr *attr,
616 		     const struct rte_flow_item *pattern,
617 		     const struct rte_flow_action *actions);
618 int port_flow_destroy(portid_t port_id, uint32_t n, const uint32_t *rule);
619 int port_flow_flush(portid_t port_id);
620 int port_flow_query(portid_t port_id, uint32_t rule,
621 		    enum rte_flow_action_type action);
622 void port_flow_list(portid_t port_id, uint32_t n, const uint32_t *group);
623 int port_flow_isolate(portid_t port_id, int set);
624 
625 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
626 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
627 
628 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
629 int set_fwd_lcores_mask(uint64_t lcoremask);
630 void set_fwd_lcores_number(uint16_t nb_lc);
631 
632 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
633 void set_fwd_ports_mask(uint64_t portmask);
634 void set_fwd_ports_number(uint16_t nb_pt);
635 int port_is_forwarding(portid_t port_id);
636 
637 void rx_vlan_strip_set(portid_t port_id, int on);
638 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
639 
640 void rx_vlan_filter_set(portid_t port_id, int on);
641 void rx_vlan_all_filter_set(portid_t port_id, int on);
642 int rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
643 void vlan_extend_set(portid_t port_id, int on);
644 void vlan_tpid_set(portid_t port_id, enum rte_vlan_type vlan_type,
645 		   uint16_t tp_id);
646 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
647 void tx_qinq_set(portid_t port_id, uint16_t vlan_id, uint16_t vlan_id_outer);
648 void tx_vlan_reset(portid_t port_id);
649 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
650 
651 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
652 
653 void set_verbose_level(uint16_t vb_level);
654 void set_tx_pkt_segments(unsigned *seg_lengths, unsigned nb_segs);
655 void show_tx_pkt_segments(void);
656 void set_tx_pkt_split(const char *name);
657 void set_nb_pkt_per_burst(uint16_t pkt_burst);
658 char *list_pkt_forwarding_modes(void);
659 char *list_pkt_forwarding_retry_modes(void);
660 void set_pkt_forwarding_mode(const char *fwd_mode);
661 void start_packet_forwarding(int with_tx_first);
662 void stop_packet_forwarding(void);
663 void dev_set_link_up(portid_t pid);
664 void dev_set_link_down(portid_t pid);
665 void init_port_config(void);
666 void set_port_slave_flag(portid_t slave_pid);
667 void clear_port_slave_flag(portid_t slave_pid);
668 uint8_t port_is_bonding_slave(portid_t slave_pid);
669 
670 int init_port_dcb_config(portid_t pid, enum dcb_mode_enable dcb_mode,
671 		     enum rte_eth_nb_tcs num_tcs,
672 		     uint8_t pfc_en);
673 int start_port(portid_t pid);
674 void stop_port(portid_t pid);
675 void close_port(portid_t pid);
676 void reset_port(portid_t pid);
677 void attach_port(char *identifier);
678 void detach_port(uint8_t port_id);
679 int all_ports_stopped(void);
680 int port_is_started(portid_t port_id);
681 void pmd_test_exit(void);
682 void fdir_get_infos(portid_t port_id);
683 void fdir_set_flex_mask(portid_t port_id,
684 			   struct rte_eth_fdir_flex_mask *cfg);
685 void fdir_set_flex_payload(portid_t port_id,
686 			   struct rte_eth_flex_payload_cfg *cfg);
687 void port_rss_reta_info(portid_t port_id,
688 			struct rte_eth_rss_reta_entry64 *reta_conf,
689 			uint16_t nb_entries);
690 
691 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
692 
693 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
694 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
695 				uint64_t q_msk);
696 
697 void port_rss_hash_conf_show(portid_t port_id, char rss_info[],
698 			     int show_rss_key);
699 void port_rss_hash_key_update(portid_t port_id, char rss_type[],
700 			      uint8_t *hash_key, uint hash_key_len);
701 void get_syn_filter(uint8_t port_id);
702 void get_ethertype_filter(uint8_t port_id, uint16_t index);
703 void get_2tuple_filter(uint8_t port_id, uint16_t index);
704 void get_5tuple_filter(uint8_t port_id, uint16_t index);
705 int rx_queue_id_is_invalid(queueid_t rxq_id);
706 int tx_queue_id_is_invalid(queueid_t txq_id);
707 void setup_gro(const char *onoff, portid_t port_id);
708 void setup_gro_flush_cycles(uint8_t cycles);
709 void show_gro(portid_t port_id);
710 void setup_gso(const char *mode, portid_t port_id);
711 
712 /* Functions to manage the set of filtered Multicast MAC addresses */
713 void mcast_addr_add(uint8_t port_id, struct ether_addr *mc_addr);
714 void mcast_addr_remove(uint8_t port_id, struct ether_addr *mc_addr);
715 void port_dcb_info_display(uint8_t port_id);
716 
717 uint8_t *open_ddp_package_file(const char *file_path, uint32_t *size);
718 int save_ddp_package_file(const char *file_path, uint8_t *buf, uint32_t size);
719 int close_ddp_package_file(uint8_t *buf);
720 
721 void port_queue_region_info_display(portid_t port_id, void *buf);
722 
723 enum print_warning {
724 	ENABLED_WARN = 0,
725 	DISABLED_WARN
726 };
727 int port_id_is_invalid(portid_t port_id, enum print_warning warning);
728 int new_socket_id(unsigned int socket_id);
729 
730 /*
731  * Work-around of a compilation error with ICC on invocations of the
732  * rte_be_to_cpu_16() function.
733  */
734 #ifdef __GCC__
735 #define RTE_BE_TO_CPU_16(be_16_v)  rte_be_to_cpu_16((be_16_v))
736 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
737 #else
738 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
739 #define RTE_BE_TO_CPU_16(be_16_v)  (be_16_v)
740 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
741 #else
742 #define RTE_BE_TO_CPU_16(be_16_v) \
743 	(uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
744 #define RTE_CPU_TO_BE_16(cpu_16_v) \
745 	(uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
746 #endif
747 #endif /* __GCC__ */
748 
749 #endif /* _TESTPMD_H_ */
750