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