xref: /dpdk/app/test-pmd/testpmd.h (revision e9fd1ebf981f361844aea9ec94e17f4bda5e1479)
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 <stdbool.h>
9 
10 #ifdef RTE_LIB_GRO
11 #include <rte_gro.h>
12 #endif
13 #ifdef RTE_LIB_GSO
14 #include <rte_gso.h>
15 #endif
16 #include <rte_os_shim.h>
17 #include <rte_ethdev.h>
18 #include <rte_flow.h>
19 #include <rte_mbuf_dyn.h>
20 
21 #include <cmdline.h>
22 #include <cmdline_parse.h>
23 
24 #include <sys/queue.h>
25 #ifdef RTE_HAS_JANSSON
26 #include <jansson.h>
27 #endif
28 
29 #define RTE_PORT_ALL            (~(portid_t)0x0)
30 
31 #define RTE_PORT_STOPPED        (uint16_t)0
32 #define RTE_PORT_STARTED        (uint16_t)1
33 #define RTE_PORT_CLOSED         (uint16_t)2
34 #define RTE_PORT_HANDLING       (uint16_t)3
35 
36 extern uint8_t cl_quit;
37 extern volatile uint8_t f_quit;
38 
39 /*
40  * It is used to allocate the memory for hash key.
41  * The hash key size is NIC dependent.
42  */
43 #define RSS_HASH_KEY_LENGTH 64
44 
45 /*
46  * Default size of the mbuf data buffer to receive standard 1518-byte
47  * Ethernet frames in a mono-segment memory buffer.
48  */
49 #define DEFAULT_MBUF_DATA_SIZE RTE_MBUF_DEFAULT_BUF_SIZE
50 /**< Default size of mbuf data buffer. */
51 
52 /*
53  * The maximum number of segments per packet is used when creating
54  * scattered transmit packets composed of a list of mbufs.
55  */
56 #define RTE_MAX_SEGS_PER_PKT 255 /**< nb_segs is a 8-bit unsigned char. */
57 
58 /*
59  * The maximum number of segments per packet is used to configure
60  * buffer split feature, also specifies the maximum amount of
61  * optional Rx pools to allocate mbufs to split.
62  */
63 #define MAX_SEGS_BUFFER_SPLIT 8 /**< nb_segs is a 8-bit unsigned char. */
64 
65 /* The prefix of the mbuf pool names created by the application. */
66 #define MBUF_POOL_NAME_PFX "mb_pool"
67 
68 #define RX_DESC_MAX    2048
69 #define TX_DESC_MAX    2048
70 
71 #define MAX_PKT_BURST 512
72 #define DEF_PKT_BURST 32
73 
74 #define DEF_MBUF_CACHE 250
75 
76 #define RTE_CACHE_LINE_SIZE_ROUNDUP(size) \
77 	(RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
78 
79 #define NUMA_NO_CONFIG 0xFF
80 #define UMA_NO_CONFIG  0xFF
81 
82 #define MIN_TOTAL_NUM_MBUFS 1024
83 
84 /* Maximum number of pools supported per Rx queue */
85 #define MAX_MEMPOOL 8
86 
87 typedef uint8_t  lcoreid_t;
88 typedef uint16_t portid_t;
89 typedef uint16_t queueid_t;
90 typedef uint16_t streamid_t;
91 
92 enum {
93 	PORT_TOPOLOGY_PAIRED,
94 	PORT_TOPOLOGY_CHAINED,
95 	PORT_TOPOLOGY_LOOP,
96 };
97 
98 enum {
99 	MP_ALLOC_NATIVE, /**< allocate and populate mempool natively */
100 	MP_ALLOC_ANON,
101 	/**< allocate mempool natively, but populate using anonymous memory */
102 	MP_ALLOC_XMEM,
103 	/**< allocate and populate mempool using anonymous memory */
104 	MP_ALLOC_XMEM_HUGE,
105 	/**< allocate and populate mempool using anonymous hugepage memory */
106 	MP_ALLOC_XBUF
107 	/**< allocate mempool natively, use rte_pktmbuf_pool_create_extbuf */
108 };
109 
110 enum {
111 	QUEUE_JOB_TYPE_FLOW_CREATE,
112 	QUEUE_JOB_TYPE_FLOW_DESTROY,
113 	QUEUE_JOB_TYPE_FLOW_TRANSFER,
114 	QUEUE_JOB_TYPE_FLOW_UPDATE,
115 	QUEUE_JOB_TYPE_ACTION_CREATE,
116 	QUEUE_JOB_TYPE_ACTION_DESTROY,
117 	QUEUE_JOB_TYPE_ACTION_UPDATE,
118 	QUEUE_JOB_TYPE_ACTION_QUERY,
119 };
120 
121 enum noisy_fwd_mode {
122 	NOISY_FWD_MODE_IO,
123 	NOISY_FWD_MODE_MAC,
124 	NOISY_FWD_MODE_MACSWAP,
125 	NOISY_FWD_MODE_5TSWAP,
126 	NOISY_FWD_MODE_MAX,
127 };
128 
129 /**
130  * The data structure associated with RX and TX packet burst statistics
131  * that are recorded for each forwarding stream.
132  */
133 struct pkt_burst_stats {
134 	unsigned int pkt_burst_spread[MAX_PKT_BURST + 1];
135 };
136 
137 
138 #define TESTPMD_RSS_TYPES_CHAR_NUM_PER_LINE 64
139 /** Information for a given RSS type. */
140 struct rss_type_info {
141 	const char *str; /**< Type name. */
142 	uint64_t rss_type; /**< Type value. */
143 };
144 
145 /**
146  * RSS type information table.
147  *
148  * An entry with a NULL type name terminates the list.
149  */
150 extern const struct rss_type_info rss_type_table[];
151 
152 /**
153  * Dynf name array.
154  *
155  * Array that holds the name for each dynf.
156  */
157 extern char dynf_names[64][RTE_MBUF_DYN_NAMESIZE];
158 
159 /**
160  * The data structure associated with a forwarding stream between a receive
161  * port/queue and a transmit port/queue.
162  */
163 struct fwd_stream {
164 	/* "read-only" data */
165 	portid_t   rx_port;   /**< port to poll for received packets */
166 	queueid_t  rx_queue;  /**< RX queue to poll on "rx_port" */
167 	portid_t   tx_port;   /**< forwarding port of received packets */
168 	queueid_t  tx_queue;  /**< TX queue to send forwarded packets */
169 	streamid_t peer_addr; /**< index of peer ethernet address of packets */
170 	bool       disabled;  /**< the stream is disabled and should not run */
171 
172 	unsigned int retry_enabled;
173 
174 	/* "read-write" results */
175 	uint64_t rx_packets;  /**< received packets */
176 	uint64_t tx_packets;  /**< received packets transmitted */
177 	uint64_t fwd_dropped; /**< received packets not forwarded */
178 	uint64_t rx_bad_ip_csum ; /**< received packets has bad ip checksum */
179 	uint64_t rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
180 	uint64_t rx_bad_outer_l4_csum;
181 	/**< received packets has bad outer l4 checksum */
182 	uint64_t rx_bad_outer_ip_csum;
183 	/**< received packets having bad outer ip checksum */
184 	uint64_t ts_skew; /**< TX scheduling timestamp */
185 #ifdef RTE_LIB_GRO
186 	unsigned int gro_times;	/**< GRO operation times */
187 #endif
188 	uint64_t busy_cycles; /**< used with --record-core-cycles */
189 	struct pkt_burst_stats rx_burst_stats;
190 	struct pkt_burst_stats tx_burst_stats;
191 	struct fwd_lcore *lcore; /**< Lcore being scheduled. */
192 	/**< Rx queue information for recycling mbufs */
193 	struct rte_eth_recycle_rxq_info recycle_rxq_info;
194 };
195 
196 /**
197  * Age action context types, must be included inside the age action
198  * context structure.
199  */
200 enum age_action_context_type {
201 	ACTION_AGE_CONTEXT_TYPE_FLOW,
202 	ACTION_AGE_CONTEXT_TYPE_INDIRECT_ACTION,
203 };
204 
205 /** Descriptor for a template. */
206 struct port_template {
207 	struct port_template *next; /**< Next template in list. */
208 	struct port_template *tmp; /**< Temporary linking. */
209 	uint32_t id; /**< Template ID. */
210 	union {
211 		struct rte_flow_pattern_template *pattern_template;
212 		struct rte_flow_actions_template *actions_template;
213 	} template; /**< PMD opaque template object */
214 };
215 
216 /** Descriptor for a flow table. */
217 struct port_table {
218 	struct port_table *next; /**< Next table in list. */
219 	struct port_table *tmp; /**< Temporary linking. */
220 	uint32_t id; /**< Table ID. */
221 	uint32_t nb_pattern_templates; /**< Number of pattern templates. */
222 	uint32_t nb_actions_templates; /**< Number of actions templates. */
223 	struct rte_flow_attr flow_attr; /**< Flow attributes. */
224 	struct rte_flow_template_table *table; /**< PMD opaque template object */
225 };
226 
227 /** Descriptor for a single flow. */
228 struct port_flow {
229 	struct port_flow *next; /**< Next flow in list. */
230 	struct port_flow *tmp; /**< Temporary linking. */
231 	uint64_t id; /**< Flow rule ID. */
232 	uint64_t user_id; /**< User rule ID. */
233 	struct port_table *table; /**< Flow table. */
234 	struct rte_flow *flow; /**< Opaque flow object returned by PMD. */
235 	struct rte_flow_conv_rule rule; /**< Saved flow rule description. */
236 	enum age_action_context_type age_type; /**< Age action context type. */
237 	uint8_t data[]; /**< Storage for flow rule description */
238 };
239 
240 /* Descriptor for indirect action */
241 struct port_indirect_action {
242 	struct port_indirect_action *next; /**< Next flow in list. */
243 	uint32_t id; /**< Indirect action ID. */
244 	enum rte_flow_action_type type; /**< Action type. */
245 	union {
246 		struct rte_flow_action_handle *handle;
247 		/**< Indirect action handle. */
248 		struct rte_flow_action_list_handle *list_handle;
249 		/**< Indirect action list handle*/
250 	};
251 	enum age_action_context_type age_type; /**< Age action context type. */
252 };
253 
254 /* Descriptor for action query data. */
255 union port_action_query {
256 	struct rte_flow_query_count count;
257 	struct rte_flow_query_age age;
258 	struct rte_flow_action_conntrack ct;
259 	struct rte_flow_query_quota quota;
260 };
261 
262 /* Descriptor for queue job. */
263 struct queue_job {
264 	uint32_t type; /**< Job type. */
265 	union {
266 		struct port_flow *pf;
267 		struct port_indirect_action *pia;
268 	};
269 	union port_action_query query;
270 };
271 
272 struct port_flow_tunnel {
273 	LIST_ENTRY(port_flow_tunnel) chain;
274 	struct rte_flow_action *pmd_actions;
275 	struct rte_flow_item   *pmd_items;
276 	uint32_t id;
277 	uint32_t num_pmd_actions;
278 	uint32_t num_pmd_items;
279 	struct rte_flow_tunnel tunnel;
280 	struct rte_flow_action *actions;
281 	struct rte_flow_item *items;
282 };
283 
284 struct tunnel_ops {
285 	uint32_t id;
286 	char type[16];
287 	uint32_t enabled:1;
288 	uint32_t actions:1;
289 	uint32_t items:1;
290 };
291 
292 /** Information for an extended statistics to show. */
293 struct xstat_display_info {
294 	/** Supported xstats IDs in the order of xstats_display */
295 	uint64_t *ids_supp;
296 	size_t   ids_supp_sz;
297 	uint64_t *prev_values;
298 	uint64_t *curr_values;
299 	uint64_t prev_ns;
300 	bool	 allocated;
301 };
302 
303 /** RX queue configuration and state. */
304 struct port_rxqueue {
305 	struct rte_eth_rxconf conf;
306 	uint8_t state; /**< RTE_ETH_QUEUE_STATE_* value. */
307 };
308 
309 /** TX queue configuration and state. */
310 struct port_txqueue {
311 	struct rte_eth_txconf conf;
312 	uint8_t state; /**< RTE_ETH_QUEUE_STATE_* value. */
313 };
314 
315 /**
316  * The data structure associated with each port.
317  */
318 struct rte_port {
319 	struct rte_eth_dev_info dev_info;   /**< Device info + driver name */
320 	struct rte_eth_conf     dev_conf;   /**< Port configuration. */
321 	struct rte_ether_addr       eth_addr;   /**< Port ethernet address */
322 	struct rte_eth_stats    stats;      /**< Last port statistics */
323 	unsigned int            socket_id;  /**< For NUMA support */
324 	uint16_t		parse_tunnel:1; /**< Parse internal headers */
325 	uint16_t                tso_segsz;  /**< Segmentation offload MSS for non-tunneled packets. */
326 	uint16_t                tunnel_tso_segsz; /**< Segmentation offload MSS for tunneled pkts. */
327 	uint16_t                tx_vlan_id;/**< The tag ID */
328 	uint16_t                tx_vlan_id_outer;/**< The outer tag ID */
329 	volatile uint16_t        port_status;    /**< port started or not */
330 	uint8_t                 need_setup;     /**< port just attached */
331 	uint8_t                 need_reconfig;  /**< need reconfiguring port or not */
332 	uint8_t                 need_reconfig_queues; /**< need reconfiguring queues or not */
333 	uint8_t                 rss_flag;   /**< enable rss or not */
334 	uint8_t                 dcb_flag;   /**< enable dcb */
335 	uint16_t                nb_rx_desc[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue rx desc number */
336 	uint16_t                nb_tx_desc[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue tx desc number */
337 	struct port_rxqueue     rxq[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue Rx config and state */
338 	struct port_txqueue     txq[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue Tx config and state */
339 	struct rte_ether_addr   *mc_addr_pool; /**< pool of multicast addrs */
340 	uint32_t                mc_addr_nb; /**< nb. of addr. in mc_addr_pool */
341 	queueid_t               queue_nb; /**< nb. of queues for flow rules */
342 	uint32_t                queue_sz; /**< size of a queue for flow rules */
343 	uint8_t                 member_flag : 1, /**< bonding member port */
344 				bond_flag : 1, /**< port is bond device */
345 				fwd_mac_swap : 1, /**< swap packet MAC before forward */
346 				update_conf : 1; /**< need to update bonding device configuration */
347 	struct port_template    *pattern_templ_list; /**< Pattern templates. */
348 	struct port_template    *actions_templ_list; /**< Actions templates. */
349 	struct port_table       *table_list; /**< Flow tables. */
350 	struct port_flow        *flow_list; /**< Associated flows. */
351 	struct port_indirect_action *actions_list;
352 	/**< Associated indirect actions. */
353 	LIST_HEAD(, port_flow_tunnel) flow_tunnel_list;
354 	const struct rte_eth_rxtx_callback *rx_dump_cb[RTE_MAX_QUEUES_PER_PORT+1];
355 	const struct rte_eth_rxtx_callback *tx_dump_cb[RTE_MAX_QUEUES_PER_PORT+1];
356 	/**< metadata value to insert in Tx packets. */
357 	uint32_t		tx_metadata;
358 	const struct rte_eth_rxtx_callback *tx_set_md_cb[RTE_MAX_QUEUES_PER_PORT+1];
359 	/**< dynamic flags. */
360 	uint64_t		mbuf_dynf;
361 	const struct rte_eth_rxtx_callback *tx_set_dynf_cb[RTE_MAX_QUEUES_PER_PORT+1];
362 	struct xstat_display_info xstats_info;
363 };
364 
365 /**
366  * The data structure associated with each forwarding logical core.
367  * The logical cores are internally numbered by a core index from 0 to
368  * the maximum number of logical cores - 1.
369  * The system CPU identifier of all logical cores are setup in a global
370  * CPU id. configuration table.
371  */
372 struct fwd_lcore {
373 #ifdef RTE_LIB_GSO
374 	struct rte_gso_ctx gso_ctx;     /**< GSO context */
375 #endif
376 	struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
377 #ifdef RTE_LIB_GRO
378 	void *gro_ctx;		/**< GRO context */
379 #endif
380 	streamid_t stream_idx;   /**< index of 1st stream in "fwd_streams" */
381 	streamid_t stream_nb;    /**< number of streams in "fwd_streams" */
382 	lcoreid_t  cpuid_idx;    /**< index of logical core in CPU id table */
383 	volatile char stopped;   /**< stop forwarding when set */
384 	uint64_t total_cycles;   /**< used with --record-core-cycles */
385 };
386 
387 /*
388  * Forwarding mode operations:
389  *   - IO forwarding mode (default mode)
390  *     Forwards packets unchanged.
391  *
392  *   - MAC forwarding mode
393  *     Set the source and the destination Ethernet addresses of packets
394  *     before forwarding them.
395  *
396  *   - IEEE1588 forwarding mode
397  *     Check that received IEEE1588 Precise Time Protocol (PTP) packets are
398  *     filtered and timestamped by the hardware.
399  *     Forwards packets unchanged on the same port.
400  *     Check that sent IEEE1588 PTP packets are timestamped by the hardware.
401  */
402 typedef int (*port_fwd_begin_t)(portid_t pi);
403 typedef void (*port_fwd_end_t)(portid_t pi);
404 typedef void (*stream_init_t)(struct fwd_stream *fs);
405 typedef bool (*packet_fwd_t)(struct fwd_stream *fs);
406 
407 struct fwd_engine {
408 	const char       *fwd_mode_name; /**< Forwarding mode name. */
409 	port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
410 	port_fwd_end_t   port_fwd_end;   /**< NULL if nothing special to do. */
411 	stream_init_t    stream_init;    /**< NULL if nothing special to do. */
412 	packet_fwd_t     packet_fwd;     /**< Mandatory. */
413 	const char       *status;        /**< NULL if nothing to display. */
414 };
415 
416 void common_fwd_stream_init(struct fwd_stream *fs);
417 
418 #define FLEX_ITEM_MAX_SAMPLES_NUM 16
419 #define FLEX_ITEM_MAX_LINKS_NUM 16
420 #define FLEX_MAX_FLOW_PATTERN_LENGTH 64
421 #define FLEX_MAX_PARSERS_NUM 8
422 #define FLEX_MAX_PATTERNS_NUM 64
423 #define FLEX_PARSER_ERR ((struct flex_item *)-1)
424 
425 struct flex_item {
426 	struct rte_flow_item_flex_conf flex_conf;
427 	struct rte_flow_item_flex_handle *flex_handle;
428 	uint32_t flex_id;
429 };
430 
431 struct flex_pattern {
432 	struct rte_flow_item_flex spec, mask;
433 	uint8_t spec_pattern[FLEX_MAX_FLOW_PATTERN_LENGTH];
434 	uint8_t mask_pattern[FLEX_MAX_FLOW_PATTERN_LENGTH];
435 };
436 extern struct flex_item *flex_items[RTE_MAX_ETHPORTS][FLEX_MAX_PARSERS_NUM];
437 extern struct flex_pattern flex_patterns[FLEX_MAX_PATTERNS_NUM];
438 
439 #define BURST_TX_WAIT_US 1
440 #define BURST_TX_RETRIES 64
441 
442 extern uint32_t burst_tx_delay_time;
443 extern uint32_t burst_tx_retry_num;
444 
445 extern struct fwd_engine io_fwd_engine;
446 extern struct fwd_engine mac_fwd_engine;
447 extern struct fwd_engine mac_swap_engine;
448 extern struct fwd_engine flow_gen_engine;
449 extern struct fwd_engine rx_only_engine;
450 extern struct fwd_engine tx_only_engine;
451 extern struct fwd_engine csum_fwd_engine;
452 extern struct fwd_engine icmp_echo_engine;
453 extern struct fwd_engine noisy_vnf_engine;
454 extern struct fwd_engine five_tuple_swap_fwd_engine;
455 extern struct fwd_engine recycle_mbufs_engine;
456 #ifdef RTE_LIBRTE_IEEE1588
457 extern struct fwd_engine ieee1588_fwd_engine;
458 #endif
459 extern struct fwd_engine shared_rxq_engine;
460 
461 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
462 extern cmdline_parse_inst_t cmd_set_raw;
463 extern cmdline_parse_inst_t cmd_show_set_raw;
464 extern cmdline_parse_inst_t cmd_show_set_raw_all;
465 extern cmdline_parse_inst_t cmd_set_flex_is_pattern;
466 extern cmdline_parse_inst_t cmd_set_flex_spec_pattern;
467 
468 extern uint16_t mempool_flags;
469 
470 /**
471  * Forwarding Configuration
472  *
473  */
474 struct fwd_config {
475 	struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
476 	streamid_t nb_fwd_streams;  /**< Nb. of forward streams to process. */
477 	lcoreid_t  nb_fwd_lcores;   /**< Nb. of logical cores to launch. */
478 	portid_t   nb_fwd_ports;    /**< Nb. of ports involved. */
479 };
480 
481 /**
482  * DCB mode enable
483  */
484 enum dcb_mode_enable
485 {
486 	DCB_VT_ENABLED,
487 	DCB_ENABLED
488 };
489 
490 extern uint8_t xstats_hide_zero; /**< Hide zero values for xstats display */
491 
492 /* globals used for configuration */
493 extern uint8_t record_core_cycles; /**< Enables measurement of CPU cycles */
494 extern uint8_t record_burst_stats; /**< Enables display of RX and TX bursts */
495 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
496 extern int testpmd_logtype; /**< Log type for testpmd logs */
497 extern uint8_t  interactive;
498 extern uint8_t  auto_start;
499 extern uint8_t  tx_first;
500 extern char cmdline_filename[PATH_MAX]; /**< offline commands file */
501 extern uint8_t  numa_support; /**< set by "--numa" parameter */
502 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
503 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
504 extern uint8_t flow_isolate_all; /**< set by "--flow-isolate-all */
505 extern uint8_t no_flow_flush; /**< set by "--disable-flow-flush" parameter */
506 extern uint8_t  mp_alloc_type;
507 /**< set by "--mp-anon" or "--mp-alloc" parameter */
508 extern uint32_t eth_link_speed;
509 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
510 extern uint8_t no_device_start; /**<set by "--disable-device-start" parameter */
511 extern volatile int test_done; /* stop packet forwarding when set to 1. */
512 extern uint8_t lsc_interrupt; /**< disabled by "--no-lsc-interrupt" parameter */
513 extern uint8_t rmv_interrupt; /**< disabled by "--no-rmv-interrupt" parameter */
514 extern uint32_t event_print_mask;
515 /**< set by "--print-event xxxx" and "--mask-event xxxx parameters */
516 extern bool setup_on_probe_event; /**< disabled by port setup-on iterator */
517 extern uint8_t hot_plug; /**< enable by "--hot-plug" parameter */
518 extern int do_mlockall; /**< set by "--mlockall" or "--no-mlockall" parameter */
519 extern uint8_t clear_ptypes; /**< disabled by set ptype cmd */
520 
521 /*
522  * Store specified sockets on which memory pool to be used by ports
523  * is allocated.
524  */
525 extern uint8_t port_numa[RTE_MAX_ETHPORTS];
526 
527 /*
528  * Store specified sockets on which RX ring to be used by ports
529  * is allocated.
530  */
531 extern uint8_t rxring_numa[RTE_MAX_ETHPORTS];
532 
533 /*
534  * Store specified sockets on which TX ring to be used by ports
535  * is allocated.
536  */
537 extern uint8_t txring_numa[RTE_MAX_ETHPORTS];
538 
539 extern uint8_t socket_num;
540 
541 /*
542  * Configuration of logical cores:
543  * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
544  */
545 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
546 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
547 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
548 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
549 extern unsigned int num_sockets;
550 extern unsigned int socket_ids[RTE_MAX_NUMA_NODES];
551 
552 /*
553  * Configuration of Ethernet ports:
554  * nb_fwd_ports <= nb_cfg_ports <= nb_ports
555  */
556 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
557 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
558 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
559 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
560 extern struct rte_port *ports;
561 
562 extern struct rte_eth_rxmode rx_mode;
563 extern struct rte_eth_txmode tx_mode;
564 
565 extern uint64_t rss_hf;
566 
567 extern queueid_t nb_hairpinq;
568 extern queueid_t nb_rxq;
569 extern queueid_t nb_txq;
570 
571 extern uint16_t nb_rxd;
572 extern uint16_t nb_txd;
573 
574 extern int16_t rx_free_thresh;
575 extern int8_t rx_drop_en;
576 extern int16_t tx_free_thresh;
577 extern int16_t tx_rs_thresh;
578 
579 extern enum noisy_fwd_mode noisy_fwd_mode;
580 extern const char * const noisy_fwd_mode_desc[];
581 extern uint16_t noisy_tx_sw_bufsz;
582 extern uint16_t noisy_tx_sw_buf_flush_time;
583 extern uint64_t noisy_lkup_mem_sz;
584 extern uint64_t noisy_lkup_num_writes;
585 extern uint64_t noisy_lkup_num_reads;
586 extern uint64_t noisy_lkup_num_reads_writes;
587 
588 extern uint8_t dcb_config;
589 
590 extern uint32_t mbuf_data_size_n;
591 extern uint16_t mbuf_data_size[MAX_SEGS_BUFFER_SPLIT];
592 /**< Mbuf data space size. */
593 extern uint32_t param_total_num_mbufs;
594 
595 extern uint16_t stats_period;
596 
597 extern struct rte_eth_xstat_name *xstats_display;
598 extern unsigned int xstats_display_num;
599 
600 extern uint32_t hairpin_mode;
601 
602 #ifdef RTE_LIB_LATENCYSTATS
603 extern uint8_t latencystats_enabled;
604 extern lcoreid_t latencystats_lcore_id;
605 #endif
606 
607 #ifdef RTE_LIB_BITRATESTATS
608 extern lcoreid_t bitrate_lcore_id;
609 extern uint8_t bitrate_enabled;
610 #endif
611 
612 extern uint32_t max_rx_pkt_len;
613 
614 /*
615  * Configuration of packet segments used to scatter received packets
616  * if some of split features is configured.
617  */
618 extern uint32_t rx_pkt_hdr_protos[MAX_SEGS_BUFFER_SPLIT];
619 extern uint16_t rx_pkt_seg_lengths[MAX_SEGS_BUFFER_SPLIT];
620 extern uint8_t  rx_pkt_nb_segs; /**< Number of segments to split */
621 extern uint16_t rx_pkt_seg_offsets[MAX_SEGS_BUFFER_SPLIT];
622 extern uint8_t  rx_pkt_nb_offs; /**< Number of specified offsets */
623 
624 extern uint8_t multi_rx_mempool; /**< Enables multi-rx-mempool feature. */
625 
626 /*
627  * Configuration of packet segments used by the "txonly" processing engine.
628  */
629 #define TXONLY_DEF_PACKET_LEN 64
630 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
631 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
632 extern uint8_t  tx_pkt_nb_segs; /**< Number of segments in TX packets */
633 extern uint32_t tx_pkt_times_intra;
634 extern uint32_t tx_pkt_times_inter;
635 
636 enum tx_pkt_split {
637 	TX_PKT_SPLIT_OFF,
638 	TX_PKT_SPLIT_ON,
639 	TX_PKT_SPLIT_RND,
640 };
641 
642 extern enum tx_pkt_split tx_pkt_split;
643 
644 extern uint8_t txonly_multi_flow;
645 
646 extern uint32_t rxq_share;
647 
648 extern uint16_t nb_pkt_per_burst;
649 extern uint16_t nb_pkt_flowgen_clones;
650 extern int nb_flows_flowgen;
651 extern uint16_t mb_mempool_cache;
652 extern int8_t rx_pthresh;
653 extern int8_t rx_hthresh;
654 extern int8_t rx_wthresh;
655 extern int8_t tx_pthresh;
656 extern int8_t tx_hthresh;
657 extern int8_t tx_wthresh;
658 
659 extern uint16_t tx_udp_src_port;
660 extern uint16_t tx_udp_dst_port;
661 
662 extern uint32_t tx_ip_src_addr;
663 extern uint32_t tx_ip_dst_addr;
664 
665 extern struct fwd_config cur_fwd_config;
666 extern struct fwd_engine *cur_fwd_eng;
667 extern uint32_t retry_enabled;
668 extern struct fwd_lcore  **fwd_lcores;
669 extern struct fwd_stream **fwd_streams;
670 
671 extern uint16_t vxlan_gpe_udp_port; /**< UDP port of tunnel VXLAN-GPE. */
672 extern uint16_t geneve_udp_port; /**< UDP port of tunnel GENEVE. */
673 
674 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
675 extern struct rte_ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
676 
677 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
678 extern uint32_t burst_tx_retry_num;  /**< Burst tx retry number for mac-retry. */
679 
680 #ifdef RTE_LIB_GRO
681 #define GRO_DEFAULT_ITEM_NUM_PER_FLOW 32
682 #define GRO_DEFAULT_FLOW_NUM (RTE_GRO_MAX_BURST_ITEM_NUM / \
683 		GRO_DEFAULT_ITEM_NUM_PER_FLOW)
684 
685 #define GRO_DEFAULT_FLUSH_CYCLES 1
686 #define GRO_MAX_FLUSH_CYCLES 4
687 
688 struct gro_status {
689 	struct rte_gro_param param;
690 	uint8_t enable;
691 };
692 extern struct gro_status gro_ports[RTE_MAX_ETHPORTS];
693 extern uint8_t gro_flush_cycles;
694 #endif /* RTE_LIB_GRO */
695 
696 #ifdef RTE_LIB_GSO
697 #define GSO_MAX_PKT_BURST 2048
698 struct gso_status {
699 	uint8_t enable;
700 };
701 extern struct gso_status gso_ports[RTE_MAX_ETHPORTS];
702 extern uint16_t gso_max_segment_size;
703 #endif /* RTE_LIB_GSO */
704 
705 /* VXLAN encap/decap parameters. */
706 struct vxlan_encap_conf {
707 	uint32_t select_ipv4:1;
708 	uint32_t select_vlan:1;
709 	uint32_t select_tos_ttl:1;
710 	uint8_t vni[3];
711 	rte_be16_t udp_src;
712 	rte_be16_t udp_dst;
713 	rte_be32_t ipv4_src;
714 	rte_be32_t ipv4_dst;
715 	uint8_t ipv6_src[16];
716 	uint8_t ipv6_dst[16];
717 	rte_be16_t vlan_tci;
718 	uint8_t ip_tos;
719 	uint8_t ip_ttl;
720 	uint8_t eth_src[RTE_ETHER_ADDR_LEN];
721 	uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
722 };
723 
724 extern struct vxlan_encap_conf vxlan_encap_conf;
725 
726 /* NVGRE encap/decap parameters. */
727 struct nvgre_encap_conf {
728 	uint32_t select_ipv4:1;
729 	uint32_t select_vlan:1;
730 	uint8_t tni[3];
731 	rte_be32_t ipv4_src;
732 	rte_be32_t ipv4_dst;
733 	uint8_t ipv6_src[16];
734 	uint8_t ipv6_dst[16];
735 	rte_be16_t vlan_tci;
736 	uint8_t eth_src[RTE_ETHER_ADDR_LEN];
737 	uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
738 };
739 
740 extern struct nvgre_encap_conf nvgre_encap_conf;
741 
742 /* L2 encap parameters. */
743 struct l2_encap_conf {
744 	uint32_t select_ipv4:1;
745 	uint32_t select_vlan:1;
746 	rte_be16_t vlan_tci;
747 	uint8_t eth_src[RTE_ETHER_ADDR_LEN];
748 	uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
749 };
750 extern struct l2_encap_conf l2_encap_conf;
751 
752 /* L2 decap parameters. */
753 struct l2_decap_conf {
754 	uint32_t select_vlan:1;
755 };
756 extern struct l2_decap_conf l2_decap_conf;
757 
758 /* MPLSoGRE encap parameters. */
759 struct mplsogre_encap_conf {
760 	uint32_t select_ipv4:1;
761 	uint32_t select_vlan:1;
762 	uint8_t label[3];
763 	rte_be32_t ipv4_src;
764 	rte_be32_t ipv4_dst;
765 	uint8_t ipv6_src[16];
766 	uint8_t ipv6_dst[16];
767 	rte_be16_t vlan_tci;
768 	uint8_t eth_src[RTE_ETHER_ADDR_LEN];
769 	uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
770 };
771 extern struct mplsogre_encap_conf mplsogre_encap_conf;
772 
773 /* MPLSoGRE decap parameters. */
774 struct mplsogre_decap_conf {
775 	uint32_t select_ipv4:1;
776 	uint32_t select_vlan:1;
777 };
778 extern struct mplsogre_decap_conf mplsogre_decap_conf;
779 
780 /* MPLSoUDP encap parameters. */
781 struct mplsoudp_encap_conf {
782 	uint32_t select_ipv4:1;
783 	uint32_t select_vlan:1;
784 	uint8_t label[3];
785 	rte_be16_t udp_src;
786 	rte_be16_t udp_dst;
787 	rte_be32_t ipv4_src;
788 	rte_be32_t ipv4_dst;
789 	uint8_t ipv6_src[16];
790 	uint8_t ipv6_dst[16];
791 	rte_be16_t vlan_tci;
792 	uint8_t eth_src[RTE_ETHER_ADDR_LEN];
793 	uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
794 };
795 extern struct mplsoudp_encap_conf mplsoudp_encap_conf;
796 
797 /* MPLSoUDP decap parameters. */
798 struct mplsoudp_decap_conf {
799 	uint32_t select_ipv4:1;
800 	uint32_t select_vlan:1;
801 };
802 extern struct mplsoudp_decap_conf mplsoudp_decap_conf;
803 
804 extern enum rte_eth_rx_mq_mode rx_mq_mode;
805 
806 extern struct rte_flow_action_conntrack conntrack_context;
807 
808 extern int proc_id;
809 extern unsigned int num_procs;
810 
811 static inline bool
812 is_proc_primary(void)
813 {
814 	return rte_eal_process_type() == RTE_PROC_PRIMARY;
815 }
816 
817 static inline struct fwd_lcore *
818 lcore_to_fwd_lcore(uint16_t lcore_id)
819 {
820 	unsigned int i;
821 
822 	for (i = 0; i < cur_fwd_config.nb_fwd_lcores; ++i) {
823 		if (fwd_lcores_cpuids[i] == lcore_id)
824 			return fwd_lcores[i];
825 	}
826 
827 	return NULL;
828 }
829 
830 static inline struct fwd_lcore *
831 current_fwd_lcore(void)
832 {
833 	struct fwd_lcore *fc = lcore_to_fwd_lcore(rte_lcore_id());
834 
835 	if (fc == NULL)
836 		rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
837 
838 	return fc;
839 }
840 
841 void
842 parse_fwd_portlist(const char *port);
843 
844 /* Mbuf Pools */
845 static inline void
846 mbuf_poolname_build(unsigned int sock_id, char *mp_name,
847 		    int name_size, uint16_t idx)
848 {
849 	if (!idx)
850 		snprintf(mp_name, name_size,
851 			 MBUF_POOL_NAME_PFX "_%u", sock_id);
852 	else
853 		snprintf(mp_name, name_size,
854 			 MBUF_POOL_NAME_PFX "_%hu_%hu", (uint16_t)sock_id, idx);
855 }
856 
857 static inline struct rte_mempool *
858 mbuf_pool_find(unsigned int sock_id, uint16_t idx)
859 {
860 	char pool_name[RTE_MEMPOOL_NAMESIZE];
861 
862 	mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name), idx);
863 	return rte_mempool_lookup((const char *)pool_name);
864 }
865 
866 static inline uint16_t
867 common_fwd_stream_receive(struct fwd_stream *fs, struct rte_mbuf **burst,
868 	unsigned int nb_pkts)
869 {
870 	uint16_t nb_rx;
871 
872 	nb_rx = rte_eth_rx_burst(fs->rx_port, fs->rx_queue, burst, nb_pkts);
873 	if (record_burst_stats)
874 		fs->rx_burst_stats.pkt_burst_spread[nb_rx]++;
875 	fs->rx_packets += nb_rx;
876 	return nb_rx;
877 }
878 
879 static inline uint16_t
880 common_fwd_stream_transmit(struct fwd_stream *fs, struct rte_mbuf **burst,
881 	unsigned int nb_pkts)
882 {
883 	uint16_t nb_tx;
884 	uint32_t retry;
885 
886 	nb_tx = rte_eth_tx_burst(fs->tx_port, fs->tx_queue, burst, nb_pkts);
887 	/*
888 	 * Retry if necessary
889 	 */
890 	if (unlikely(nb_tx < nb_pkts) && fs->retry_enabled) {
891 		retry = 0;
892 		while (nb_tx < nb_pkts && retry++ < burst_tx_retry_num) {
893 			rte_delay_us(burst_tx_delay_time);
894 			nb_tx += rte_eth_tx_burst(fs->tx_port, fs->tx_queue,
895 				&burst[nb_tx], nb_pkts - nb_tx);
896 		}
897 	}
898 	fs->tx_packets += nb_tx;
899 	if (record_burst_stats)
900 		fs->tx_burst_stats.pkt_burst_spread[nb_tx]++;
901 	if (unlikely(nb_tx < nb_pkts)) {
902 		fs->fwd_dropped += (nb_pkts - nb_tx);
903 		rte_pktmbuf_free_bulk(&burst[nb_tx], nb_pkts - nb_tx);
904 	}
905 
906 	return nb_tx;
907 }
908 
909 /* Prototypes */
910 unsigned int parse_item_list(const char *str, const char *item_name,
911 			unsigned int max_items,
912 			unsigned int *parsed_items, int check_unique_values);
913 unsigned int parse_hdrs_list(const char *str, const char *item_name,
914 			unsigned int max_item,
915 			unsigned int *parsed_items);
916 void launch_args_parse(int argc, char** argv);
917 void cmd_reconfig_device_queue(portid_t id, uint8_t dev, uint8_t queue);
918 void cmdline_read_from_file(const char *filename);
919 int init_cmdline(void);
920 void prompt(void);
921 void prompt_exit(void);
922 void nic_stats_display(portid_t port_id);
923 void nic_stats_clear(portid_t port_id);
924 void nic_xstats_display(portid_t port_id);
925 void nic_xstats_clear(portid_t port_id);
926 void device_infos_display(const char *identifier);
927 void port_infos_display(portid_t port_id);
928 void port_summary_display(portid_t port_id);
929 void port_eeprom_display(portid_t port_id);
930 void port_module_eeprom_display(portid_t port_id);
931 void port_summary_header_display(void);
932 void rx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
933 void tx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
934 void fwd_lcores_config_display(void);
935 bool pkt_fwd_shared_rxq_check(void);
936 void pkt_fwd_config_display(struct fwd_config *cfg);
937 void rxtx_config_display(void);
938 void fwd_config_setup(void);
939 void set_def_fwd_config(void);
940 void reconfig(portid_t new_port_id, unsigned socket_id);
941 int init_fwd_streams(void);
942 void update_fwd_ports(portid_t new_pid);
943 
944 void set_fwd_eth_peer(portid_t port_id, char *peer_addr);
945 
946 void port_mtu_set(portid_t port_id, uint16_t mtu);
947 int port_action_handle_create(portid_t port_id, uint32_t id, bool indirect_list,
948 			      const struct rte_flow_indir_action_conf *conf,
949 			      const struct rte_flow_action *action);
950 int port_action_handle_destroy(portid_t port_id,
951 			       uint32_t n, const uint32_t *action);
952 int port_action_handle_flush(portid_t port_id);
953 struct rte_flow_action_handle *port_action_handle_get_by_id(portid_t port_id,
954 							    uint32_t id);
955 int port_action_handle_update(portid_t port_id, uint32_t id,
956 			      const struct rte_flow_action *action);
957 void
958 port_action_handle_query_update(portid_t port_id, uint32_t id,
959 				enum rte_flow_query_update_mode qu_mode,
960 				const struct rte_flow_action *action);
961 int port_flow_get_info(portid_t port_id);
962 int port_flow_configure(portid_t port_id,
963 			const struct rte_flow_port_attr *port_attr,
964 			uint16_t nb_queue,
965 			const struct rte_flow_queue_attr *queue_attr);
966 int port_flow_pattern_template_create(portid_t port_id, uint32_t id,
967 				      const struct rte_flow_pattern_template_attr *attr,
968 				      const struct rte_flow_item *pattern);
969 int port_flow_pattern_template_destroy(portid_t port_id, uint32_t n,
970 				       const uint32_t *template);
971 int port_flow_pattern_template_flush(portid_t port_id);
972 int port_flow_actions_template_create(portid_t port_id, uint32_t id,
973 				      const struct rte_flow_actions_template_attr *attr,
974 				      const struct rte_flow_action *actions,
975 				      const struct rte_flow_action *masks);
976 int port_flow_actions_template_destroy(portid_t port_id, uint32_t n,
977 				       const uint32_t *template);
978 int port_flow_actions_template_flush(portid_t port_id);
979 int port_flow_template_table_create(portid_t port_id, uint32_t id,
980 		   const struct rte_flow_template_table_attr *table_attr,
981 		   uint32_t nb_pattern_templates, uint32_t *pattern_templates,
982 		   uint32_t nb_actions_templates, uint32_t *actions_templates);
983 int port_flow_template_table_destroy(portid_t port_id,
984 			    uint32_t n, const uint32_t *table);
985 int port_queue_flow_update_resized(portid_t port_id, queueid_t queue_id,
986 				   bool postpone, uint32_t flow_id);
987 int port_flow_template_table_flush(portid_t port_id);
988 int port_flow_template_table_resize_complete(portid_t port_id, uint32_t table_id);
989 int port_flow_template_table_resize(portid_t port_id,
990 				    uint32_t table_id, uint32_t flows_num);
991 int port_queue_group_set_miss_actions(portid_t port_id, const struct rte_flow_attr *attr,
992 				      const struct rte_flow_action *actions);
993 int port_queue_flow_create(portid_t port_id, queueid_t queue_id,
994 			   bool postpone, uint32_t table_id, uint32_t rule_idx,
995 			   uint32_t pattern_idx, uint32_t actions_idx,
996 			   const struct rte_flow_item *pattern,
997 			   const struct rte_flow_action *actions);
998 int port_queue_flow_destroy(portid_t port_id, queueid_t queue_id,
999 			    bool postpone, uint32_t n, const uint64_t *rule);
1000 int port_queue_flow_update(portid_t port_id, queueid_t queue_id,
1001 			   bool postpone, uint32_t rule_idx, uint32_t actions_idx,
1002 			   const struct rte_flow_action *actions);
1003 int port_queue_action_handle_create(portid_t port_id, uint32_t queue_id,
1004 			bool postpone, uint32_t id,
1005 			const struct rte_flow_indir_action_conf *conf,
1006 			const struct rte_flow_action *action);
1007 int port_queue_action_handle_destroy(portid_t port_id,
1008 				     uint32_t queue_id, bool postpone,
1009 				     uint32_t n, const uint32_t *action);
1010 int port_queue_action_handle_update(portid_t port_id, uint32_t queue_id,
1011 				    bool postpone, uint32_t id,
1012 				    const struct rte_flow_action *action);
1013 int port_queue_action_handle_query(portid_t port_id, uint32_t queue_id,
1014 				   bool postpone, uint32_t id);
1015 void
1016 port_queue_action_handle_query_update(portid_t port_id,
1017 				      uint32_t queue_id, bool postpone,
1018 				      uint32_t id,
1019 				      enum rte_flow_query_update_mode qu_mode,
1020 				      const struct rte_flow_action *action);
1021 int port_queue_flow_push(portid_t port_id, queueid_t queue_id);
1022 int port_queue_flow_pull(portid_t port_id, queueid_t queue_id);
1023 int port_flow_hash_calc(portid_t port_id, uint32_t table_id,
1024 			uint8_t pattern_template_index, const struct rte_flow_item pattern[]);
1025 int port_flow_hash_calc_encap(portid_t port_id,
1026 			      enum rte_flow_encap_hash_field encap_hash_field,
1027 			      const struct rte_flow_item pattern[]);
1028 void port_queue_flow_aged(portid_t port_id, uint32_t queue_id, uint8_t destroy);
1029 int port_flow_validate(portid_t port_id,
1030 		       const struct rte_flow_attr *attr,
1031 		       const struct rte_flow_item *pattern,
1032 		       const struct rte_flow_action *actions,
1033 		       const struct tunnel_ops *tunnel_ops);
1034 int port_flow_create(portid_t port_id,
1035 		     const struct rte_flow_attr *attr,
1036 		     const struct rte_flow_item *pattern,
1037 		     const struct rte_flow_action *actions,
1038 		     const struct tunnel_ops *tunnel_ops,
1039 		     uintptr_t user_id);
1040 int port_action_handle_query(portid_t port_id, uint32_t id);
1041 void update_age_action_context(const struct rte_flow_action *actions,
1042 		     struct port_flow *pf);
1043 int mcast_addr_pool_destroy(portid_t port_id);
1044 int port_flow_destroy(portid_t port_id, uint32_t n, const uint64_t *rule,
1045 		      bool is_user_id);
1046 int port_flow_update(portid_t port_id, uint32_t rule,
1047 		     const struct rte_flow_action *actions, bool is_user_id);
1048 int port_flow_flush(portid_t port_id);
1049 int port_flow_dump(portid_t port_id, bool dump_all,
1050 			uint64_t rule, const char *file_name,
1051 			bool is_user_id);
1052 int port_flow_query(portid_t port_id, uint64_t rule,
1053 		    const struct rte_flow_action *action, bool is_user_id);
1054 void port_flow_list(portid_t port_id, uint32_t n, const uint32_t *group);
1055 void port_flow_aged(portid_t port_id, uint8_t destroy);
1056 const char *port_flow_tunnel_type(struct rte_flow_tunnel *tunnel);
1057 struct port_flow_tunnel *
1058 port_flow_locate_tunnel(uint16_t port_id, struct rte_flow_tunnel *tun);
1059 void port_flow_tunnel_list(portid_t port_id);
1060 void port_flow_tunnel_destroy(portid_t port_id, uint32_t tunnel_id);
1061 void port_flow_tunnel_create(portid_t port_id, const struct tunnel_ops *ops);
1062 int port_flow_isolate(portid_t port_id, int set);
1063 int port_meter_policy_add(portid_t port_id, uint32_t policy_id,
1064 		const struct rte_flow_action *actions);
1065 struct rte_flow_meter_profile *port_meter_profile_get_by_id(portid_t port_id,
1066 							    uint32_t id);
1067 struct rte_flow_meter_policy *port_meter_policy_get_by_id(portid_t port_id,
1068 							  uint32_t id);
1069 
1070 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
1071 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
1072 
1073 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
1074 int set_fwd_lcores_mask(uint64_t lcoremask);
1075 void set_fwd_lcores_number(uint16_t nb_lc);
1076 
1077 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
1078 void set_fwd_ports_mask(uint64_t portmask);
1079 void set_fwd_ports_number(uint16_t nb_pt);
1080 int port_is_forwarding(portid_t port_id);
1081 
1082 void rx_vlan_strip_set(portid_t port_id, int on);
1083 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
1084 
1085 void rx_vlan_filter_set(portid_t port_id, int on);
1086 void rx_vlan_all_filter_set(portid_t port_id, int on);
1087 void rx_vlan_qinq_strip_set(portid_t port_id, int on);
1088 int rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
1089 void vlan_extend_set(portid_t port_id, int on);
1090 void vlan_tpid_set(portid_t port_id, enum rte_vlan_type vlan_type,
1091 		   uint16_t tp_id);
1092 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
1093 void tx_qinq_set(portid_t port_id, uint16_t vlan_id, uint16_t vlan_id_outer);
1094 void tx_vlan_reset(portid_t port_id);
1095 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
1096 
1097 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
1098 
1099 void set_xstats_hide_zero(uint8_t on_off);
1100 
1101 void set_record_core_cycles(uint8_t on_off);
1102 void set_record_burst_stats(uint8_t on_off);
1103 void set_verbose_level(uint16_t vb_level);
1104 void set_rx_pkt_segments(unsigned int *seg_lengths, unsigned int nb_segs);
1105 void set_rx_pkt_hdrs(unsigned int *seg_protos, unsigned int nb_segs);
1106 void show_rx_pkt_hdrs(void);
1107 void show_rx_pkt_segments(void);
1108 void set_rx_pkt_offsets(unsigned int *seg_offsets, unsigned int nb_offs);
1109 void show_rx_pkt_offsets(void);
1110 void set_tx_pkt_segments(unsigned int *seg_lengths, unsigned int nb_segs);
1111 void show_tx_pkt_segments(void);
1112 void set_tx_pkt_times(unsigned int *tx_times);
1113 void show_tx_pkt_times(void);
1114 void set_tx_pkt_split(const char *name);
1115 int parse_fec_mode(const char *name, uint32_t *fec_capa);
1116 void show_fec_capability(uint32_t num, struct rte_eth_fec_capa *speed_fec_capa);
1117 void set_nb_pkt_per_burst(uint16_t pkt_burst);
1118 char *list_pkt_forwarding_modes(void);
1119 char *list_pkt_forwarding_retry_modes(void);
1120 void set_pkt_forwarding_mode(const char *fwd_mode);
1121 void start_packet_forwarding(int with_tx_first);
1122 void fwd_stats_display(void);
1123 void fwd_stats_reset(void);
1124 void stop_packet_forwarding(void);
1125 void dev_set_link_up(portid_t pid);
1126 void dev_set_link_down(portid_t pid);
1127 void init_port_config(void);
1128 void set_port_member_flag(portid_t member_pid);
1129 void clear_port_member_flag(portid_t member_pid);
1130 uint8_t port_is_bonding_member(portid_t member_pid);
1131 
1132 int init_port_dcb_config(portid_t pid, enum dcb_mode_enable dcb_mode,
1133 		     enum rte_eth_nb_tcs num_tcs,
1134 		     uint8_t pfc_en);
1135 int start_port(portid_t pid);
1136 void stop_port(portid_t pid);
1137 void close_port(portid_t pid);
1138 void reset_port(portid_t pid);
1139 void attach_port(char *identifier);
1140 void detach_devargs(char *identifier);
1141 void detach_port_device(portid_t port_id);
1142 int all_ports_stopped(void);
1143 int port_is_stopped(portid_t port_id);
1144 int port_is_started(portid_t port_id);
1145 void pmd_test_exit(void);
1146 #if defined(RTE_NET_I40E) || defined(RTE_NET_IXGBE)
1147 void fdir_get_infos(portid_t port_id);
1148 #endif
1149 void port_rss_reta_info(portid_t port_id,
1150 			struct rte_eth_rss_reta_entry64 *reta_conf,
1151 			uint16_t nb_entries);
1152 
1153 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
1154 
1155 int
1156 rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
1157 	       uint16_t nb_rx_desc, unsigned int socket_id,
1158 	       struct rte_eth_rxconf *rx_conf, struct rte_mempool *mp);
1159 
1160 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint32_t rate);
1161 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint32_t rate,
1162 				uint64_t q_msk);
1163 
1164 int set_rxq_avail_thresh(portid_t port_id, uint16_t queue_id,
1165 			 uint8_t avail_thresh);
1166 
1167 void port_rss_hash_conf_show(portid_t port_id, int show_rss_key, int show_rss_algo);
1168 void port_rss_hash_key_update(portid_t port_id, char rss_type[],
1169 			      uint8_t *hash_key, uint8_t hash_key_len);
1170 int rx_queue_id_is_invalid(queueid_t rxq_id);
1171 int tx_queue_id_is_invalid(queueid_t txq_id);
1172 #ifdef RTE_LIB_GRO
1173 void setup_gro(const char *onoff, portid_t port_id);
1174 void setup_gro_flush_cycles(uint8_t cycles);
1175 void show_gro(portid_t port_id);
1176 #endif
1177 #ifdef RTE_LIB_GSO
1178 void setup_gso(const char *mode, portid_t port_id);
1179 #endif
1180 int eth_dev_info_get_print_err(uint16_t port_id,
1181 			struct rte_eth_dev_info *dev_info);
1182 int eth_dev_conf_get_print_err(uint16_t port_id,
1183 			struct rte_eth_conf *dev_conf);
1184 void eth_set_promisc_mode(uint16_t port_id, int enable);
1185 void eth_set_allmulticast_mode(uint16_t port, int enable);
1186 int eth_link_get_nowait_print_err(uint16_t port_id, struct rte_eth_link *link);
1187 int eth_macaddr_get_print_err(uint16_t port_id,
1188 			struct rte_ether_addr *mac_addr);
1189 
1190 /* Functions to display the set of MAC addresses added to a port*/
1191 void show_macs(portid_t port_id);
1192 void show_mcast_macs(portid_t port_id);
1193 
1194 /* Functions to manage the set of filtered Multicast MAC addresses */
1195 void mcast_addr_add(portid_t port_id, struct rte_ether_addr *mc_addr);
1196 void mcast_addr_remove(portid_t port_id, struct rte_ether_addr *mc_addr);
1197 void mcast_addr_flush(portid_t port_id);
1198 void port_dcb_info_display(portid_t port_id);
1199 
1200 uint8_t *open_file(const char *file_path, uint32_t *size);
1201 int save_file(const char *file_path, uint8_t *buf, uint32_t size);
1202 int close_file(uint8_t *buf);
1203 
1204 enum print_warning {
1205 	ENABLED_WARN = 0,
1206 	DISABLED_WARN
1207 };
1208 int port_id_is_invalid(portid_t port_id, enum print_warning warning);
1209 void print_valid_ports(void);
1210 int new_socket_id(unsigned int socket_id);
1211 
1212 queueid_t get_allowed_max_nb_rxq(portid_t *pid);
1213 int check_nb_rxq(queueid_t rxq);
1214 queueid_t get_allowed_max_nb_txq(portid_t *pid);
1215 int check_nb_txq(queueid_t txq);
1216 int check_nb_rxd(queueid_t rxd);
1217 int check_nb_txd(queueid_t txd);
1218 queueid_t get_allowed_max_nb_hairpinq(portid_t *pid);
1219 int check_nb_hairpinq(queueid_t hairpinq);
1220 
1221 uint16_t dump_rx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
1222 		      uint16_t nb_pkts, __rte_unused uint16_t max_pkts,
1223 		      __rte_unused void *user_param);
1224 
1225 uint16_t dump_tx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
1226 		      uint16_t nb_pkts, __rte_unused void *user_param);
1227 
1228 void add_rx_dump_callbacks(portid_t portid);
1229 void remove_rx_dump_callbacks(portid_t portid);
1230 void add_tx_dump_callbacks(portid_t portid);
1231 void remove_tx_dump_callbacks(portid_t portid);
1232 void configure_rxtx_dump_callbacks(uint16_t verbose);
1233 
1234 uint16_t tx_pkt_set_md(uint16_t port_id, __rte_unused uint16_t queue,
1235 		       struct rte_mbuf *pkts[], uint16_t nb_pkts,
1236 		       __rte_unused void *user_param);
1237 void add_tx_md_callback(portid_t portid);
1238 void remove_tx_md_callback(portid_t portid);
1239 
1240 uint16_t tx_pkt_set_dynf(uint16_t port_id, __rte_unused uint16_t queue,
1241 			 struct rte_mbuf *pkts[], uint16_t nb_pkts,
1242 			 __rte_unused void *user_param);
1243 void add_tx_dynf_callback(portid_t portid);
1244 void remove_tx_dynf_callback(portid_t portid);
1245 int update_mtu_from_frame_size(portid_t portid, uint32_t max_rx_pktlen);
1246 void flex_item_create(portid_t port_id, uint16_t flex_id, const char *filename);
1247 void flex_item_destroy(portid_t port_id, uint16_t flex_id);
1248 void port_flex_item_flush(portid_t port_id);
1249 
1250 extern int flow_parse(const char *src, void *result, unsigned int size,
1251 		      struct rte_flow_attr **attr,
1252 		      struct rte_flow_item **pattern,
1253 		      struct rte_flow_action **actions);
1254 
1255 uint64_t str_to_rsstypes(const char *str);
1256 const char *rsstypes_to_str(uint64_t rss_type);
1257 
1258 uint16_t str_to_flowtype(const char *string);
1259 const char *flowtype_to_str(uint16_t flow_type);
1260 
1261 /* For registering driver specific testpmd commands. */
1262 struct testpmd_driver_commands {
1263 	TAILQ_ENTRY(testpmd_driver_commands) next;
1264 	struct {
1265 		cmdline_parse_inst_t *ctx;
1266 		const char *help;
1267 	} commands[];
1268 };
1269 
1270 void testpmd_add_driver_commands(struct testpmd_driver_commands *c);
1271 #define TESTPMD_ADD_DRIVER_COMMANDS(c) \
1272 RTE_INIT(__##c) \
1273 { \
1274 	testpmd_add_driver_commands(&c); \
1275 }
1276 
1277 /*
1278  * Work-around of a compilation error with ICC on invocations of the
1279  * rte_be_to_cpu_16() function.
1280  */
1281 #ifdef __GCC__
1282 #define RTE_BE_TO_CPU_16(be_16_v)  rte_be_to_cpu_16((be_16_v))
1283 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
1284 #else
1285 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
1286 #define RTE_BE_TO_CPU_16(be_16_v)  (be_16_v)
1287 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
1288 #else
1289 #define RTE_BE_TO_CPU_16(be_16_v) \
1290 	(uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
1291 #define RTE_CPU_TO_BE_16(cpu_16_v) \
1292 	(uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
1293 #endif
1294 #endif /* __GCC__ */
1295 
1296 #define TESTPMD_LOG(level, fmt, args...) \
1297 	rte_log(RTE_LOG_ ## level, testpmd_logtype, "testpmd: " fmt, ## args)
1298 
1299 #endif /* _TESTPMD_H_ */
1300