1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2017 Intel Corporation
11 #include <rte_bus_pci.h>
18 #include <rte_os_shim.h>
20 #include <sys/queue.h>
21 #ifdef RTE_HAS_JANSSON
25 #define RTE_PORT_ALL (~(portid_t)0x0)
27 #define RTE_TEST_RX_DESC_MAX 2048
28 #define RTE_TEST_TX_DESC_MAX 2048
30 #define RTE_PORT_STOPPED (uint16_t)0
31 #define RTE_PORT_STARTED (uint16_t)1
32 #define RTE_PORT_CLOSED (uint16_t)2
33 #define RTE_PORT_HANDLING (uint16_t)3
36 * It is used to allocate the memory for hash key.
37 * The hash key size is NIC dependent.
39 #define RSS_HASH_KEY_LENGTH 64
42 * Default size of the mbuf data buffer to receive standard 1518-byte
43 * Ethernet frames in a mono-segment memory buffer.
45 #define DEFAULT_MBUF_DATA_SIZE RTE_MBUF_DEFAULT_BUF_SIZE
46 /**< Default size of mbuf data buffer. */
49 * The maximum number of segments per packet is used when creating
50 * scattered transmit packets composed of a list of mbufs.
52 #define RTE_MAX_SEGS_PER_PKT 255 /**< nb_segs is a 8-bit unsigned char. */
55 * The maximum number of segments per packet is used to configure
56 * buffer split feature, also specifies the maximum amount of
57 * optional Rx pools to allocate mbufs to split.
59 #define MAX_SEGS_BUFFER_SPLIT 8 /**< nb_segs is a 8-bit unsigned char. */
61 /* The prefix of the mbuf pool names created by the application. */
62 #define MBUF_POOL_NAME_PFX "mb_pool"
64 #define MAX_PKT_BURST 512
65 #define DEF_PKT_BURST 32
67 #define DEF_MBUF_CACHE 250
69 #define RTE_CACHE_LINE_SIZE_ROUNDUP(size) \
70 (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
72 #define NUMA_NO_CONFIG 0xFF
73 #define UMA_NO_CONFIG 0xFF
75 typedef uint8_t lcoreid_t;
76 typedef uint16_t portid_t;
77 typedef uint16_t queueid_t;
78 typedef uint16_t streamid_t;
82 PORT_TOPOLOGY_CHAINED,
87 MP_ALLOC_NATIVE, /**< allocate and populate mempool natively */
89 /**< allocate mempool natively, but populate using anonymous memory */
91 /**< allocate and populate mempool using anonymous memory */
93 /**< allocate and populate mempool using anonymous hugepage memory */
95 /**< allocate mempool natively, use rte_pktmbuf_pool_create_extbuf */
99 * The data structure associated with RX and TX packet burst statistics
100 * that are recorded for each forwarding stream.
102 struct pkt_burst_stats {
103 unsigned int pkt_burst_spread[MAX_PKT_BURST + 1];
106 /** Information for a given RSS type. */
107 struct rss_type_info {
108 const char *str; /**< Type name. */
109 uint64_t rss_type; /**< Type value. */
113 * RSS type information table.
115 * An entry with a NULL type name terminates the list.
117 extern const struct rss_type_info rss_type_table[];
122 * Array that holds the name for each dynf.
124 extern char dynf_names[64][RTE_MBUF_DYN_NAMESIZE];
127 * The data structure associated with a forwarding stream between a receive
128 * port/queue and a transmit port/queue.
131 /* "read-only" data */
132 portid_t rx_port; /**< port to poll for received packets */
133 queueid_t rx_queue; /**< RX queue to poll on "rx_port" */
134 portid_t tx_port; /**< forwarding port of received packets */
135 queueid_t tx_queue; /**< TX queue to send forwarded packets */
136 streamid_t peer_addr; /**< index of peer ethernet address of packets */
138 unsigned int retry_enabled;
140 /* "read-write" results */
141 uint64_t rx_packets; /**< received packets */
142 uint64_t tx_packets; /**< received packets transmitted */
143 uint64_t fwd_dropped; /**< received packets not forwarded */
144 uint64_t rx_bad_ip_csum ; /**< received packets has bad ip checksum */
145 uint64_t rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
146 uint64_t rx_bad_outer_l4_csum;
147 /**< received packets has bad outer l4 checksum */
148 uint64_t rx_bad_outer_ip_csum;
149 /**< received packets having bad outer ip checksum */
150 uint64_t ts_skew; /**< TX scheduling timestamp */
152 unsigned int gro_times; /**< GRO operation times */
154 uint64_t core_cycles; /**< used for RX and TX processing */
155 struct pkt_burst_stats rx_burst_stats;
156 struct pkt_burst_stats tx_burst_stats;
157 struct fwd_lcore *lcore; /**< Lcore being scheduled. */
161 * Age action context types, must be included inside the age action
164 enum age_action_context_type {
165 ACTION_AGE_CONTEXT_TYPE_FLOW,
166 ACTION_AGE_CONTEXT_TYPE_INDIRECT_ACTION,
169 /** Descriptor for a template. */
170 struct port_template {
171 struct port_template *next; /**< Next template in list. */
172 struct port_template *tmp; /**< Temporary linking. */
173 uint32_t id; /**< Template ID. */
175 struct rte_flow_pattern_template *pattern_template;
176 struct rte_flow_actions_template *actions_template;
177 } template; /**< PMD opaque template object */
180 /** Descriptor for a flow table. */
182 struct port_table *next; /**< Next table in list. */
183 struct port_table *tmp; /**< Temporary linking. */
184 uint32_t id; /**< Table ID. */
185 uint32_t nb_pattern_templates; /**< Number of pattern templates. */
186 uint32_t nb_actions_templates; /**< Number of actions templates. */
187 struct rte_flow_template_table *table; /**< PMD opaque template object */
190 /** Descriptor for a single flow. */
192 struct port_flow *next; /**< Next flow in list. */
193 struct port_flow *tmp; /**< Temporary linking. */
194 uint32_t id; /**< Flow rule ID. */
195 struct rte_flow *flow; /**< Opaque flow object returned by PMD. */
196 struct rte_flow_conv_rule rule; /**< Saved flow rule description. */
197 enum age_action_context_type age_type; /**< Age action context type. */
198 uint8_t data[]; /**< Storage for flow rule description */
201 /* Descriptor for indirect action */
202 struct port_indirect_action {
203 struct port_indirect_action *next; /**< Next flow in list. */
204 uint32_t id; /**< Indirect action ID. */
205 enum rte_flow_action_type type; /**< Action type. */
206 struct rte_flow_action_handle *handle; /**< Indirect action handle. */
207 enum age_action_context_type age_type; /**< Age action context type. */
210 struct port_flow_tunnel {
211 LIST_ENTRY(port_flow_tunnel) chain;
212 struct rte_flow_action *pmd_actions;
213 struct rte_flow_item *pmd_items;
215 uint32_t num_pmd_actions;
216 uint32_t num_pmd_items;
217 struct rte_flow_tunnel tunnel;
218 struct rte_flow_action *actions;
219 struct rte_flow_item *items;
230 /** Information for an extended statistics to show. */
231 struct xstat_display_info {
232 /** Supported xstats IDs in the order of xstats_display */
235 uint64_t *prev_values;
236 uint64_t *curr_values;
242 * The data structure associated with each port.
245 struct rte_eth_dev_info dev_info; /**< PCI info + driver name */
246 struct rte_eth_conf dev_conf; /**< Port configuration. */
247 struct rte_ether_addr eth_addr; /**< Port ethernet address */
248 struct rte_eth_stats stats; /**< Last port statistics */
249 unsigned int socket_id; /**< For NUMA support */
250 uint16_t parse_tunnel:1; /**< Parse internal headers */
251 uint16_t tso_segsz; /**< Segmentation offload MSS for non-tunneled packets. */
252 uint16_t tunnel_tso_segsz; /**< Segmentation offload MSS for tunneled pkts. */
253 uint16_t tx_vlan_id;/**< The tag ID */
254 uint16_t tx_vlan_id_outer;/**< The outer tag ID */
255 volatile uint16_t port_status; /**< port started or not */
256 uint8_t need_setup; /**< port just attached */
257 uint8_t need_reconfig; /**< need reconfiguring port or not */
258 uint8_t need_reconfig_queues; /**< need reconfiguring queues or not */
259 uint8_t rss_flag; /**< enable rss or not */
260 uint8_t dcb_flag; /**< enable dcb */
261 uint16_t nb_rx_desc[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue rx desc number */
262 uint16_t nb_tx_desc[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue tx desc number */
263 struct rte_eth_rxconf rx_conf[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue rx configuration */
264 struct rte_eth_txconf tx_conf[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue tx configuration */
265 struct rte_ether_addr *mc_addr_pool; /**< pool of multicast addrs */
266 uint32_t mc_addr_nb; /**< nb. of addr. in mc_addr_pool */
267 queueid_t queue_nb; /**< nb. of queues for flow rules */
268 uint32_t queue_sz; /**< size of a queue for flow rules */
269 uint8_t slave_flag; /**< bonding slave port */
270 struct port_template *pattern_templ_list; /**< Pattern templates. */
271 struct port_template *actions_templ_list; /**< Actions templates. */
272 struct port_table *table_list; /**< Flow tables. */
273 struct port_flow *flow_list; /**< Associated flows. */
274 struct port_indirect_action *actions_list;
275 /**< Associated indirect actions. */
276 LIST_HEAD(, port_flow_tunnel) flow_tunnel_list;
277 const struct rte_eth_rxtx_callback *rx_dump_cb[RTE_MAX_QUEUES_PER_PORT+1];
278 const struct rte_eth_rxtx_callback *tx_dump_cb[RTE_MAX_QUEUES_PER_PORT+1];
279 /**< metadata value to insert in Tx packets. */
280 uint32_t tx_metadata;
281 const struct rte_eth_rxtx_callback *tx_set_md_cb[RTE_MAX_QUEUES_PER_PORT+1];
282 /**< dynamic flags. */
284 const struct rte_eth_rxtx_callback *tx_set_dynf_cb[RTE_MAX_QUEUES_PER_PORT+1];
285 struct xstat_display_info xstats_info;
289 * The data structure associated with each forwarding logical core.
290 * The logical cores are internally numbered by a core index from 0 to
291 * the maximum number of logical cores - 1.
292 * The system CPU identifier of all logical cores are setup in a global
293 * CPU id. configuration table.
297 struct rte_gso_ctx gso_ctx; /**< GSO context */
299 struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
301 void *gro_ctx; /**< GRO context */
303 streamid_t stream_idx; /**< index of 1st stream in "fwd_streams" */
304 streamid_t stream_nb; /**< number of streams in "fwd_streams" */
305 lcoreid_t cpuid_idx; /**< index of logical core in CPU id table */
306 volatile char stopped; /**< stop forwarding when set */
310 * Forwarding mode operations:
311 * - IO forwarding mode (default mode)
312 * Forwards packets unchanged.
314 * - MAC forwarding mode
315 * Set the source and the destination Ethernet addresses of packets
316 * before forwarding them.
318 * - IEEE1588 forwarding mode
319 * Check that received IEEE1588 Precise Time Protocol (PTP) packets are
320 * filtered and timestamped by the hardware.
321 * Forwards packets unchanged on the same port.
322 * Check that sent IEEE1588 PTP packets are timestamped by the hardware.
324 typedef int (*port_fwd_begin_t)(portid_t pi);
325 typedef void (*port_fwd_end_t)(portid_t pi);
326 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
329 const char *fwd_mode_name; /**< Forwarding mode name. */
330 port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
331 port_fwd_end_t port_fwd_end; /**< NULL if nothing special to do. */
332 packet_fwd_t packet_fwd; /**< Mandatory. */
335 #define FLEX_ITEM_MAX_SAMPLES_NUM 16
336 #define FLEX_ITEM_MAX_LINKS_NUM 16
337 #define FLEX_MAX_FLOW_PATTERN_LENGTH 64
338 #define FLEX_MAX_PARSERS_NUM 8
339 #define FLEX_MAX_PATTERNS_NUM 64
340 #define FLEX_PARSER_ERR ((struct flex_item *)-1)
343 struct rte_flow_item_flex_conf flex_conf;
344 struct rte_flow_item_flex_handle *flex_handle;
348 struct flex_pattern {
349 struct rte_flow_item_flex spec, mask;
350 uint8_t spec_pattern[FLEX_MAX_FLOW_PATTERN_LENGTH];
351 uint8_t mask_pattern[FLEX_MAX_FLOW_PATTERN_LENGTH];
353 extern struct flex_item *flex_items[RTE_MAX_ETHPORTS][FLEX_MAX_PARSERS_NUM];
354 extern struct flex_pattern flex_patterns[FLEX_MAX_PATTERNS_NUM];
356 #define BURST_TX_WAIT_US 1
357 #define BURST_TX_RETRIES 64
359 extern uint32_t burst_tx_delay_time;
360 extern uint32_t burst_tx_retry_num;
362 extern struct fwd_engine io_fwd_engine;
363 extern struct fwd_engine mac_fwd_engine;
364 extern struct fwd_engine mac_swap_engine;
365 extern struct fwd_engine flow_gen_engine;
366 extern struct fwd_engine rx_only_engine;
367 extern struct fwd_engine tx_only_engine;
368 extern struct fwd_engine csum_fwd_engine;
369 extern struct fwd_engine icmp_echo_engine;
370 extern struct fwd_engine noisy_vnf_engine;
371 extern struct fwd_engine five_tuple_swap_fwd_engine;
372 #ifdef RTE_LIBRTE_IEEE1588
373 extern struct fwd_engine ieee1588_fwd_engine;
375 extern struct fwd_engine shared_rxq_engine;
377 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
378 extern cmdline_parse_inst_t cmd_set_raw;
379 extern cmdline_parse_inst_t cmd_show_set_raw;
380 extern cmdline_parse_inst_t cmd_show_set_raw_all;
381 extern cmdline_parse_inst_t cmd_set_flex_is_pattern;
382 extern cmdline_parse_inst_t cmd_set_flex_spec_pattern;
384 extern uint16_t mempool_flags;
387 * Forwarding Configuration
391 struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
392 streamid_t nb_fwd_streams; /**< Nb. of forward streams to process. */
393 lcoreid_t nb_fwd_lcores; /**< Nb. of logical cores to launch. */
394 portid_t nb_fwd_ports; /**< Nb. of ports involved. */
406 extern uint8_t xstats_hide_zero; /**< Hide zero values for xstats display */
408 /* globals used for configuration */
409 extern uint8_t record_core_cycles; /**< Enables measurement of CPU cycles */
410 extern uint8_t record_burst_stats; /**< Enables display of RX and TX bursts */
411 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
412 extern int testpmd_logtype; /**< Log type for testpmd logs */
413 extern uint8_t interactive;
414 extern uint8_t auto_start;
415 extern uint8_t tx_first;
416 extern char cmdline_filename[PATH_MAX]; /**< offline commands file */
417 extern uint8_t numa_support; /**< set by "--numa" parameter */
418 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
419 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
420 extern uint8_t flow_isolate_all; /**< set by "--flow-isolate-all */
421 extern uint8_t mp_alloc_type;
422 /**< set by "--mp-anon" or "--mp-alloc" parameter */
423 extern uint32_t eth_link_speed;
424 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
425 extern uint8_t no_device_start; /**<set by "--disable-device-start" parameter */
426 extern volatile int test_done; /* stop packet forwarding when set to 1. */
427 extern uint8_t lsc_interrupt; /**< disabled by "--no-lsc-interrupt" parameter */
428 extern uint8_t rmv_interrupt; /**< disabled by "--no-rmv-interrupt" parameter */
429 extern uint32_t event_print_mask;
430 /**< set by "--print-event xxxx" and "--mask-event xxxx parameters */
431 extern bool setup_on_probe_event; /**< disabled by port setup-on iterator */
432 extern uint8_t hot_plug; /**< enable by "--hot-plug" parameter */
433 extern int do_mlockall; /**< set by "--mlockall" or "--no-mlockall" parameter */
434 extern uint8_t clear_ptypes; /**< disabled by set ptype cmd */
436 #ifdef RTE_LIBRTE_IXGBE_BYPASS
437 extern uint32_t bypass_timeout; /**< Store the NIC bypass watchdog timeout */
441 * Store specified sockets on which memory pool to be used by ports
444 extern uint8_t port_numa[RTE_MAX_ETHPORTS];
447 * Store specified sockets on which RX ring to be used by ports
450 extern uint8_t rxring_numa[RTE_MAX_ETHPORTS];
453 * Store specified sockets on which TX ring to be used by ports
456 extern uint8_t txring_numa[RTE_MAX_ETHPORTS];
458 extern uint8_t socket_num;
461 * Configuration of logical cores:
462 * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
464 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
465 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
466 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
467 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
468 extern unsigned int num_sockets;
469 extern unsigned int socket_ids[RTE_MAX_NUMA_NODES];
472 * Configuration of Ethernet ports:
473 * nb_fwd_ports <= nb_cfg_ports <= nb_ports
475 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
476 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
477 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
478 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
479 extern struct rte_port *ports;
481 extern struct rte_eth_rxmode rx_mode;
482 extern struct rte_eth_txmode tx_mode;
484 extern uint64_t rss_hf;
486 extern queueid_t nb_hairpinq;
487 extern queueid_t nb_rxq;
488 extern queueid_t nb_txq;
490 extern uint16_t nb_rxd;
491 extern uint16_t nb_txd;
493 extern int16_t rx_free_thresh;
494 extern int8_t rx_drop_en;
495 extern int16_t tx_free_thresh;
496 extern int16_t tx_rs_thresh;
498 extern uint16_t noisy_tx_sw_bufsz;
499 extern uint16_t noisy_tx_sw_buf_flush_time;
500 extern uint64_t noisy_lkup_mem_sz;
501 extern uint64_t noisy_lkup_num_writes;
502 extern uint64_t noisy_lkup_num_reads;
503 extern uint64_t noisy_lkup_num_reads_writes;
505 extern uint8_t dcb_config;
507 extern uint32_t mbuf_data_size_n;
508 extern uint16_t mbuf_data_size[MAX_SEGS_BUFFER_SPLIT];
509 /**< Mbuf data space size. */
510 extern uint32_t param_total_num_mbufs;
512 extern uint16_t stats_period;
514 extern struct rte_eth_xstat_name *xstats_display;
515 extern unsigned int xstats_display_num;
517 extern uint16_t hairpin_mode;
519 #ifdef RTE_LIB_LATENCYSTATS
520 extern uint8_t latencystats_enabled;
521 extern lcoreid_t latencystats_lcore_id;
524 #ifdef RTE_LIB_BITRATESTATS
525 extern lcoreid_t bitrate_lcore_id;
526 extern uint8_t bitrate_enabled;
529 extern struct rte_eth_fdir_conf fdir_conf;
531 extern uint32_t max_rx_pkt_len;
534 * Configuration of packet segments used to scatter received packets
535 * if some of split features is configured.
537 extern uint16_t rx_pkt_seg_lengths[MAX_SEGS_BUFFER_SPLIT];
538 extern uint8_t rx_pkt_nb_segs; /**< Number of segments to split */
539 extern uint16_t rx_pkt_seg_offsets[MAX_SEGS_BUFFER_SPLIT];
540 extern uint8_t rx_pkt_nb_offs; /**< Number of specified offsets */
543 * Configuration of packet segments used by the "txonly" processing engine.
545 #define TXONLY_DEF_PACKET_LEN 64
546 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
547 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
548 extern uint8_t tx_pkt_nb_segs; /**< Number of segments in TX packets */
549 extern uint32_t tx_pkt_times_intra;
550 extern uint32_t tx_pkt_times_inter;
558 extern enum tx_pkt_split tx_pkt_split;
560 extern uint8_t txonly_multi_flow;
562 extern uint32_t rxq_share;
564 extern uint16_t nb_pkt_per_burst;
565 extern uint16_t nb_pkt_flowgen_clones;
566 extern int nb_flows_flowgen;
567 extern uint16_t mb_mempool_cache;
568 extern int8_t rx_pthresh;
569 extern int8_t rx_hthresh;
570 extern int8_t rx_wthresh;
571 extern int8_t tx_pthresh;
572 extern int8_t tx_hthresh;
573 extern int8_t tx_wthresh;
575 extern uint16_t tx_udp_src_port;
576 extern uint16_t tx_udp_dst_port;
578 extern uint32_t tx_ip_src_addr;
579 extern uint32_t tx_ip_dst_addr;
581 extern struct fwd_config cur_fwd_config;
582 extern struct fwd_engine *cur_fwd_eng;
583 extern uint32_t retry_enabled;
584 extern struct fwd_lcore **fwd_lcores;
585 extern struct fwd_stream **fwd_streams;
587 extern uint16_t vxlan_gpe_udp_port; /**< UDP port of tunnel VXLAN-GPE. */
588 extern uint16_t geneve_udp_port; /**< UDP port of tunnel GENEVE. */
590 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
591 extern struct rte_ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
593 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
594 extern uint32_t burst_tx_retry_num; /**< Burst tx retry number for mac-retry. */
597 #define GRO_DEFAULT_ITEM_NUM_PER_FLOW 32
598 #define GRO_DEFAULT_FLOW_NUM (RTE_GRO_MAX_BURST_ITEM_NUM / \
599 GRO_DEFAULT_ITEM_NUM_PER_FLOW)
601 #define GRO_DEFAULT_FLUSH_CYCLES 1
602 #define GRO_MAX_FLUSH_CYCLES 4
605 struct rte_gro_param param;
608 extern struct gro_status gro_ports[RTE_MAX_ETHPORTS];
609 extern uint8_t gro_flush_cycles;
610 #endif /* RTE_LIB_GRO */
613 #define GSO_MAX_PKT_BURST 2048
617 extern struct gso_status gso_ports[RTE_MAX_ETHPORTS];
618 extern uint16_t gso_max_segment_size;
619 #endif /* RTE_LIB_GSO */
621 /* VXLAN encap/decap parameters. */
622 struct vxlan_encap_conf {
623 uint32_t select_ipv4:1;
624 uint32_t select_vlan:1;
625 uint32_t select_tos_ttl:1;
631 uint8_t ipv6_src[16];
632 uint8_t ipv6_dst[16];
636 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
637 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
640 extern struct vxlan_encap_conf vxlan_encap_conf;
642 /* NVGRE encap/decap parameters. */
643 struct nvgre_encap_conf {
644 uint32_t select_ipv4:1;
645 uint32_t select_vlan:1;
649 uint8_t ipv6_src[16];
650 uint8_t ipv6_dst[16];
652 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
653 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
656 extern struct nvgre_encap_conf nvgre_encap_conf;
658 /* L2 encap parameters. */
659 struct l2_encap_conf {
660 uint32_t select_ipv4:1;
661 uint32_t select_vlan:1;
663 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
664 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
666 extern struct l2_encap_conf l2_encap_conf;
668 /* L2 decap parameters. */
669 struct l2_decap_conf {
670 uint32_t select_vlan:1;
672 extern struct l2_decap_conf l2_decap_conf;
674 /* MPLSoGRE encap parameters. */
675 struct mplsogre_encap_conf {
676 uint32_t select_ipv4:1;
677 uint32_t select_vlan:1;
681 uint8_t ipv6_src[16];
682 uint8_t ipv6_dst[16];
684 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
685 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
687 extern struct mplsogre_encap_conf mplsogre_encap_conf;
689 /* MPLSoGRE decap parameters. */
690 struct mplsogre_decap_conf {
691 uint32_t select_ipv4:1;
692 uint32_t select_vlan:1;
694 extern struct mplsogre_decap_conf mplsogre_decap_conf;
696 /* MPLSoUDP encap parameters. */
697 struct mplsoudp_encap_conf {
698 uint32_t select_ipv4:1;
699 uint32_t select_vlan:1;
705 uint8_t ipv6_src[16];
706 uint8_t ipv6_dst[16];
708 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
709 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
711 extern struct mplsoudp_encap_conf mplsoudp_encap_conf;
713 /* MPLSoUDP decap parameters. */
714 struct mplsoudp_decap_conf {
715 uint32_t select_ipv4:1;
716 uint32_t select_vlan:1;
718 extern struct mplsoudp_decap_conf mplsoudp_decap_conf;
720 extern enum rte_eth_rx_mq_mode rx_mq_mode;
722 extern struct rte_flow_action_conntrack conntrack_context;
725 extern unsigned int num_procs;
728 is_proc_primary(void)
730 return rte_eal_process_type() == RTE_PROC_PRIMARY;
733 static inline unsigned int
738 for (i = 0; i < RTE_MAX_LCORE; ++i)
739 if (fwd_lcores_cpuids[i] == rte_lcore_id())
742 rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
746 parse_fwd_portlist(const char *port);
748 static inline struct fwd_lcore *
749 current_fwd_lcore(void)
751 return fwd_lcores[lcore_num()];
756 mbuf_poolname_build(unsigned int sock_id, char *mp_name,
757 int name_size, uint16_t idx)
760 snprintf(mp_name, name_size,
761 MBUF_POOL_NAME_PFX "_%u", sock_id);
763 snprintf(mp_name, name_size,
764 MBUF_POOL_NAME_PFX "_%hu_%hu", (uint16_t)sock_id, idx);
767 static inline struct rte_mempool *
768 mbuf_pool_find(unsigned int sock_id, uint16_t idx)
770 char pool_name[RTE_MEMPOOL_NAMESIZE];
772 mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name), idx);
773 return rte_mempool_lookup((const char *)pool_name);
777 * Read/Write operations on a PCI register of a port.
779 static inline uint32_t
780 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
782 const struct rte_pci_device *pci_dev;
783 const struct rte_bus *bus;
787 if (!port->dev_info.device) {
788 fprintf(stderr, "Invalid device\n");
792 bus = rte_bus_find_by_device(port->dev_info.device);
793 if (bus && !strcmp(bus->name, "pci")) {
794 pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
796 fprintf(stderr, "Not a PCI device\n");
800 reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
801 reg_v = *((volatile uint32_t *)reg_addr);
802 return rte_le_to_cpu_32(reg_v);
805 #define port_id_pci_reg_read(pt_id, reg_off) \
806 port_pci_reg_read(&ports[(pt_id)], (reg_off))
809 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
811 const struct rte_pci_device *pci_dev;
812 const struct rte_bus *bus;
815 if (!port->dev_info.device) {
816 fprintf(stderr, "Invalid device\n");
820 bus = rte_bus_find_by_device(port->dev_info.device);
821 if (bus && !strcmp(bus->name, "pci")) {
822 pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
824 fprintf(stderr, "Not a PCI device\n");
828 reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
829 *((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
832 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
833 port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
836 get_start_cycles(uint64_t *start_tsc)
838 if (record_core_cycles)
839 *start_tsc = rte_rdtsc();
843 get_end_cycles(struct fwd_stream *fs, uint64_t start_tsc)
845 if (record_core_cycles)
846 fs->core_cycles += rte_rdtsc() - start_tsc;
850 inc_rx_burst_stats(struct fwd_stream *fs, uint16_t nb_rx)
852 if (record_burst_stats)
853 fs->rx_burst_stats.pkt_burst_spread[nb_rx]++;
857 inc_tx_burst_stats(struct fwd_stream *fs, uint16_t nb_tx)
859 if (record_burst_stats)
860 fs->tx_burst_stats.pkt_burst_spread[nb_tx]++;
864 unsigned int parse_item_list(const char *str, const char *item_name,
865 unsigned int max_items,
866 unsigned int *parsed_items, int check_unique_values);
867 void launch_args_parse(int argc, char** argv);
868 void cmdline_read_from_file(const char *filename);
870 void prompt_exit(void);
871 void nic_stats_display(portid_t port_id);
872 void nic_stats_clear(portid_t port_id);
873 void nic_xstats_display(portid_t port_id);
874 void nic_xstats_clear(portid_t port_id);
875 void device_infos_display(const char *identifier);
876 void port_infos_display(portid_t port_id);
877 void port_summary_display(portid_t port_id);
878 void port_eeprom_display(portid_t port_id);
879 void port_module_eeprom_display(portid_t port_id);
880 void port_summary_header_display(void);
881 void rx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
882 void tx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
883 void fwd_lcores_config_display(void);
884 bool pkt_fwd_shared_rxq_check(void);
885 void pkt_fwd_config_display(struct fwd_config *cfg);
886 void rxtx_config_display(void);
887 void fwd_config_setup(void);
888 void set_def_fwd_config(void);
889 void reconfig(portid_t new_port_id, unsigned socket_id);
890 int init_fwd_streams(void);
891 void update_fwd_ports(portid_t new_pid);
893 void set_fwd_eth_peer(portid_t port_id, char *peer_addr);
895 void port_mtu_set(portid_t port_id, uint16_t mtu);
896 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
897 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
899 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
900 uint8_t bit1_pos, uint8_t bit2_pos);
901 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
902 uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
903 void port_reg_display(portid_t port_id, uint32_t reg_off);
904 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
905 int port_action_handle_create(portid_t port_id, uint32_t id,
906 const struct rte_flow_indir_action_conf *conf,
907 const struct rte_flow_action *action);
908 int port_action_handle_destroy(portid_t port_id,
909 uint32_t n, const uint32_t *action);
910 struct rte_flow_action_handle *port_action_handle_get_by_id(portid_t port_id,
912 int port_action_handle_update(portid_t port_id, uint32_t id,
913 const struct rte_flow_action *action);
914 int port_flow_get_info(portid_t port_id);
915 int port_flow_configure(portid_t port_id,
916 const struct rte_flow_port_attr *port_attr,
918 const struct rte_flow_queue_attr *queue_attr);
919 int port_flow_pattern_template_create(portid_t port_id, uint32_t id,
920 const struct rte_flow_pattern_template_attr *attr,
921 const struct rte_flow_item *pattern);
922 int port_flow_pattern_template_destroy(portid_t port_id, uint32_t n,
923 const uint32_t *template);
924 int port_flow_actions_template_create(portid_t port_id, uint32_t id,
925 const struct rte_flow_actions_template_attr *attr,
926 const struct rte_flow_action *actions,
927 const struct rte_flow_action *masks);
928 int port_flow_actions_template_destroy(portid_t port_id, uint32_t n,
929 const uint32_t *template);
930 int port_flow_template_table_create(portid_t port_id, uint32_t id,
931 const struct rte_flow_template_table_attr *table_attr,
932 uint32_t nb_pattern_templates, uint32_t *pattern_templates,
933 uint32_t nb_actions_templates, uint32_t *actions_templates);
934 int port_flow_template_table_destroy(portid_t port_id,
935 uint32_t n, const uint32_t *table);
936 int port_queue_flow_create(portid_t port_id, queueid_t queue_id,
937 bool postpone, uint32_t table_id,
938 uint32_t pattern_idx, uint32_t actions_idx,
939 const struct rte_flow_item *pattern,
940 const struct rte_flow_action *actions);
941 int port_queue_flow_destroy(portid_t port_id, queueid_t queue_id,
942 bool postpone, uint32_t n, const uint32_t *rule);
943 int port_flow_validate(portid_t port_id,
944 const struct rte_flow_attr *attr,
945 const struct rte_flow_item *pattern,
946 const struct rte_flow_action *actions,
947 const struct tunnel_ops *tunnel_ops);
948 int port_flow_create(portid_t port_id,
949 const struct rte_flow_attr *attr,
950 const struct rte_flow_item *pattern,
951 const struct rte_flow_action *actions,
952 const struct tunnel_ops *tunnel_ops);
953 int port_action_handle_query(portid_t port_id, uint32_t id);
954 void update_age_action_context(const struct rte_flow_action *actions,
955 struct port_flow *pf);
956 int port_flow_destroy(portid_t port_id, uint32_t n, const uint32_t *rule);
957 int port_flow_flush(portid_t port_id);
958 int port_flow_dump(portid_t port_id, bool dump_all,
959 uint32_t rule, const char *file_name);
960 int port_flow_query(portid_t port_id, uint32_t rule,
961 const struct rte_flow_action *action);
962 void port_flow_list(portid_t port_id, uint32_t n, const uint32_t *group);
963 void port_flow_aged(portid_t port_id, uint8_t destroy);
964 const char *port_flow_tunnel_type(struct rte_flow_tunnel *tunnel);
965 struct port_flow_tunnel *
966 port_flow_locate_tunnel(uint16_t port_id, struct rte_flow_tunnel *tun);
967 void port_flow_tunnel_list(portid_t port_id);
968 void port_flow_tunnel_destroy(portid_t port_id, uint32_t tunnel_id);
969 void port_flow_tunnel_create(portid_t port_id, const struct tunnel_ops *ops);
970 int port_flow_isolate(portid_t port_id, int set);
971 int port_meter_policy_add(portid_t port_id, uint32_t policy_id,
972 const struct rte_flow_action *actions);
974 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
975 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
977 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
978 int set_fwd_lcores_mask(uint64_t lcoremask);
979 void set_fwd_lcores_number(uint16_t nb_lc);
981 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
982 void set_fwd_ports_mask(uint64_t portmask);
983 void set_fwd_ports_number(uint16_t nb_pt);
984 int port_is_forwarding(portid_t port_id);
986 void rx_vlan_strip_set(portid_t port_id, int on);
987 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
989 void rx_vlan_filter_set(portid_t port_id, int on);
990 void rx_vlan_all_filter_set(portid_t port_id, int on);
991 void rx_vlan_qinq_strip_set(portid_t port_id, int on);
992 int rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
993 void vlan_extend_set(portid_t port_id, int on);
994 void vlan_tpid_set(portid_t port_id, enum rte_vlan_type vlan_type,
996 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
997 void tx_qinq_set(portid_t port_id, uint16_t vlan_id, uint16_t vlan_id_outer);
998 void tx_vlan_reset(portid_t port_id);
999 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
1001 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
1003 void set_xstats_hide_zero(uint8_t on_off);
1005 void set_record_core_cycles(uint8_t on_off);
1006 void set_record_burst_stats(uint8_t on_off);
1007 void set_verbose_level(uint16_t vb_level);
1008 void set_rx_pkt_segments(unsigned int *seg_lengths, unsigned int nb_segs);
1009 void show_rx_pkt_segments(void);
1010 void set_rx_pkt_offsets(unsigned int *seg_offsets, unsigned int nb_offs);
1011 void show_rx_pkt_offsets(void);
1012 void set_tx_pkt_segments(unsigned int *seg_lengths, unsigned int nb_segs);
1013 void show_tx_pkt_segments(void);
1014 void set_tx_pkt_times(unsigned int *tx_times);
1015 void show_tx_pkt_times(void);
1016 void set_tx_pkt_split(const char *name);
1017 int parse_fec_mode(const char *name, uint32_t *fec_capa);
1018 void show_fec_capability(uint32_t num, struct rte_eth_fec_capa *speed_fec_capa);
1019 void set_nb_pkt_per_burst(uint16_t pkt_burst);
1020 char *list_pkt_forwarding_modes(void);
1021 char *list_pkt_forwarding_retry_modes(void);
1022 void set_pkt_forwarding_mode(const char *fwd_mode);
1023 void start_packet_forwarding(int with_tx_first);
1024 void fwd_stats_display(void);
1025 void fwd_stats_reset(void);
1026 void stop_packet_forwarding(void);
1027 void dev_set_link_up(portid_t pid);
1028 void dev_set_link_down(portid_t pid);
1029 void init_port_config(void);
1030 void set_port_slave_flag(portid_t slave_pid);
1031 void clear_port_slave_flag(portid_t slave_pid);
1032 uint8_t port_is_bonding_slave(portid_t slave_pid);
1034 int init_port_dcb_config(portid_t pid, enum dcb_mode_enable dcb_mode,
1035 enum rte_eth_nb_tcs num_tcs,
1037 int start_port(portid_t pid);
1038 void stop_port(portid_t pid);
1039 void close_port(portid_t pid);
1040 void reset_port(portid_t pid);
1041 void attach_port(char *identifier);
1042 void detach_devargs(char *identifier);
1043 void detach_port_device(portid_t port_id);
1044 int all_ports_stopped(void);
1045 int port_is_stopped(portid_t port_id);
1046 int port_is_started(portid_t port_id);
1047 void pmd_test_exit(void);
1048 #if defined(RTE_NET_I40E) || defined(RTE_NET_IXGBE)
1049 void fdir_get_infos(portid_t port_id);
1051 void fdir_set_flex_mask(portid_t port_id,
1052 struct rte_eth_fdir_flex_mask *cfg);
1053 void fdir_set_flex_payload(portid_t port_id,
1054 struct rte_eth_flex_payload_cfg *cfg);
1055 void port_rss_reta_info(portid_t port_id,
1056 struct rte_eth_rss_reta_entry64 *reta_conf,
1057 uint16_t nb_entries);
1059 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
1062 rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
1063 uint16_t nb_rx_desc, unsigned int socket_id,
1064 struct rte_eth_rxconf *rx_conf, struct rte_mempool *mp);
1066 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
1067 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
1070 void port_rss_hash_conf_show(portid_t port_id, int show_rss_key);
1071 void port_rss_hash_key_update(portid_t port_id, char rss_type[],
1072 uint8_t *hash_key, uint8_t hash_key_len);
1073 int rx_queue_id_is_invalid(queueid_t rxq_id);
1074 int tx_queue_id_is_invalid(queueid_t txq_id);
1076 void setup_gro(const char *onoff, portid_t port_id);
1077 void setup_gro_flush_cycles(uint8_t cycles);
1078 void show_gro(portid_t port_id);
1081 void setup_gso(const char *mode, portid_t port_id);
1083 int eth_dev_info_get_print_err(uint16_t port_id,
1084 struct rte_eth_dev_info *dev_info);
1085 int eth_dev_conf_get_print_err(uint16_t port_id,
1086 struct rte_eth_conf *dev_conf);
1087 void eth_set_promisc_mode(uint16_t port_id, int enable);
1088 void eth_set_allmulticast_mode(uint16_t port, int enable);
1089 int eth_link_get_nowait_print_err(uint16_t port_id, struct rte_eth_link *link);
1090 int eth_macaddr_get_print_err(uint16_t port_id,
1091 struct rte_ether_addr *mac_addr);
1093 /* Functions to display the set of MAC addresses added to a port*/
1094 void show_macs(portid_t port_id);
1095 void show_mcast_macs(portid_t port_id);
1097 /* Functions to manage the set of filtered Multicast MAC addresses */
1098 void mcast_addr_add(portid_t port_id, struct rte_ether_addr *mc_addr);
1099 void mcast_addr_remove(portid_t port_id, struct rte_ether_addr *mc_addr);
1100 void port_dcb_info_display(portid_t port_id);
1102 uint8_t *open_file(const char *file_path, uint32_t *size);
1103 int save_file(const char *file_path, uint8_t *buf, uint32_t size);
1104 int close_file(uint8_t *buf);
1106 void port_queue_region_info_display(portid_t port_id, void *buf);
1108 enum print_warning {
1112 int port_id_is_invalid(portid_t port_id, enum print_warning warning);
1113 void print_valid_ports(void);
1114 int new_socket_id(unsigned int socket_id);
1116 queueid_t get_allowed_max_nb_rxq(portid_t *pid);
1117 int check_nb_rxq(queueid_t rxq);
1118 queueid_t get_allowed_max_nb_txq(portid_t *pid);
1119 int check_nb_txq(queueid_t txq);
1120 int check_nb_rxd(queueid_t rxd);
1121 int check_nb_txd(queueid_t txd);
1122 queueid_t get_allowed_max_nb_hairpinq(portid_t *pid);
1123 int check_nb_hairpinq(queueid_t hairpinq);
1125 uint16_t dump_rx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
1126 uint16_t nb_pkts, __rte_unused uint16_t max_pkts,
1127 __rte_unused void *user_param);
1129 uint16_t dump_tx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
1130 uint16_t nb_pkts, __rte_unused void *user_param);
1132 void add_rx_dump_callbacks(portid_t portid);
1133 void remove_rx_dump_callbacks(portid_t portid);
1134 void add_tx_dump_callbacks(portid_t portid);
1135 void remove_tx_dump_callbacks(portid_t portid);
1136 void configure_rxtx_dump_callbacks(uint16_t verbose);
1138 uint16_t tx_pkt_set_md(uint16_t port_id, __rte_unused uint16_t queue,
1139 struct rte_mbuf *pkts[], uint16_t nb_pkts,
1140 __rte_unused void *user_param);
1141 void add_tx_md_callback(portid_t portid);
1142 void remove_tx_md_callback(portid_t portid);
1144 uint16_t tx_pkt_set_dynf(uint16_t port_id, __rte_unused uint16_t queue,
1145 struct rte_mbuf *pkts[], uint16_t nb_pkts,
1146 __rte_unused void *user_param);
1147 void add_tx_dynf_callback(portid_t portid);
1148 void remove_tx_dynf_callback(portid_t portid);
1149 int update_mtu_from_frame_size(portid_t portid, uint32_t max_rx_pktlen);
1150 int update_jumbo_frame_offload(portid_t portid);
1151 void flex_item_create(portid_t port_id, uint16_t flex_id, const char *filename);
1152 void flex_item_destroy(portid_t port_id, uint16_t flex_id);
1153 void port_flex_item_flush(portid_t port_id);
1155 extern int flow_parse(const char *src, void *result, unsigned int size,
1156 struct rte_flow_attr **attr,
1157 struct rte_flow_item **pattern,
1158 struct rte_flow_action **actions);
1161 * Work-around of a compilation error with ICC on invocations of the
1162 * rte_be_to_cpu_16() function.
1165 #define RTE_BE_TO_CPU_16(be_16_v) rte_be_to_cpu_16((be_16_v))
1166 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
1168 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
1169 #define RTE_BE_TO_CPU_16(be_16_v) (be_16_v)
1170 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
1172 #define RTE_BE_TO_CPU_16(be_16_v) \
1173 (uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
1174 #define RTE_CPU_TO_BE_16(cpu_16_v) \
1175 (uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
1177 #endif /* __GCC__ */
1179 #define TESTPMD_LOG(level, fmt, args...) \
1180 rte_log(RTE_LOG_ ## level, testpmd_logtype, "testpmd: " fmt, ## args)
1182 #endif /* _TESTPMD_H_ */