1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2017 Intel Corporation
11 #include <rte_bus_pci.h>
14 #include <rte_os_shim.h>
16 #include <sys/queue.h>
18 #define RTE_PORT_ALL (~(portid_t)0x0)
20 #define RTE_TEST_RX_DESC_MAX 2048
21 #define RTE_TEST_TX_DESC_MAX 2048
23 #define RTE_PORT_STOPPED (uint16_t)0
24 #define RTE_PORT_STARTED (uint16_t)1
25 #define RTE_PORT_CLOSED (uint16_t)2
26 #define RTE_PORT_HANDLING (uint16_t)3
29 * It is used to allocate the memory for hash key.
30 * The hash key size is NIC dependent.
32 #define RSS_HASH_KEY_LENGTH 64
35 * Default size of the mbuf data buffer to receive standard 1518-byte
36 * Ethernet frames in a mono-segment memory buffer.
38 #define DEFAULT_MBUF_DATA_SIZE RTE_MBUF_DEFAULT_BUF_SIZE
39 /**< Default size of mbuf data buffer. */
42 * The maximum number of segments per packet is used when creating
43 * scattered transmit packets composed of a list of mbufs.
45 #define RTE_MAX_SEGS_PER_PKT 255 /**< nb_segs is a 8-bit unsigned char. */
48 * The maximum number of segments per packet is used to configure
49 * buffer split feature, also specifies the maximum amount of
50 * optional Rx pools to allocate mbufs to split.
52 #define MAX_SEGS_BUFFER_SPLIT 8 /**< nb_segs is a 8-bit unsigned char. */
54 /* The prefix of the mbuf pool names created by the application. */
55 #define MBUF_POOL_NAME_PFX "mb_pool"
57 #define MAX_PKT_BURST 512
58 #define DEF_PKT_BURST 32
60 #define DEF_MBUF_CACHE 250
62 #define RTE_CACHE_LINE_SIZE_ROUNDUP(size) \
63 (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
65 #define NUMA_NO_CONFIG 0xFF
66 #define UMA_NO_CONFIG 0xFF
68 typedef uint8_t lcoreid_t;
69 typedef uint16_t portid_t;
70 typedef uint16_t queueid_t;
71 typedef uint16_t streamid_t;
75 PORT_TOPOLOGY_CHAINED,
80 MP_ALLOC_NATIVE, /**< allocate and populate mempool natively */
82 /**< allocate mempool natively, but populate using anonymous memory */
84 /**< allocate and populate mempool using anonymous memory */
86 /**< allocate and populate mempool using anonymous hugepage memory */
88 /**< allocate mempool natively, use rte_pktmbuf_pool_create_extbuf */
92 * The data structure associated with RX and TX packet burst statistics
93 * that are recorded for each forwarding stream.
95 struct pkt_burst_stats {
96 unsigned int pkt_burst_spread[MAX_PKT_BURST];
99 /** Information for a given RSS type. */
100 struct rss_type_info {
101 const char *str; /**< Type name. */
102 uint64_t rss_type; /**< Type value. */
106 * RSS type information table.
108 * An entry with a NULL type name terminates the list.
110 extern const struct rss_type_info rss_type_table[];
115 * Array that holds the name for each dynf.
117 extern char dynf_names[64][RTE_MBUF_DYN_NAMESIZE];
120 * The data structure associated with a forwarding stream between a receive
121 * port/queue and a transmit port/queue.
124 /* "read-only" data */
125 portid_t rx_port; /**< port to poll for received packets */
126 queueid_t rx_queue; /**< RX queue to poll on "rx_port" */
127 portid_t tx_port; /**< forwarding port of received packets */
128 queueid_t tx_queue; /**< TX queue to send forwarded packets */
129 streamid_t peer_addr; /**< index of peer ethernet address of packets */
131 unsigned int retry_enabled;
133 /* "read-write" results */
134 uint64_t rx_packets; /**< received packets */
135 uint64_t tx_packets; /**< received packets transmitted */
136 uint64_t fwd_dropped; /**< received packets not forwarded */
137 uint64_t rx_bad_ip_csum ; /**< received packets has bad ip checksum */
138 uint64_t rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
139 uint64_t rx_bad_outer_l4_csum;
140 /**< received packets has bad outer l4 checksum */
141 uint64_t rx_bad_outer_ip_csum;
142 /**< received packets having bad outer ip checksum */
143 unsigned int gro_times; /**< GRO operation times */
144 uint64_t core_cycles; /**< used for RX and TX processing */
145 struct pkt_burst_stats rx_burst_stats;
146 struct pkt_burst_stats tx_burst_stats;
150 * Age action context types, must be included inside the age action
153 enum age_action_context_type {
154 ACTION_AGE_CONTEXT_TYPE_FLOW,
155 ACTION_AGE_CONTEXT_TYPE_INDIRECT_ACTION,
158 /** Descriptor for a single flow. */
160 struct port_flow *next; /**< Next flow in list. */
161 struct port_flow *tmp; /**< Temporary linking. */
162 uint32_t id; /**< Flow rule ID. */
163 struct rte_flow *flow; /**< Opaque flow object returned by PMD. */
164 struct rte_flow_conv_rule rule; /**< Saved flow rule description. */
165 enum age_action_context_type age_type; /**< Age action context type. */
166 uint8_t data[]; /**< Storage for flow rule description */
169 /* Descriptor for indirect action */
170 struct port_indirect_action {
171 struct port_indirect_action *next; /**< Next flow in list. */
172 uint32_t id; /**< Indirect action ID. */
173 enum rte_flow_action_type type; /**< Action type. */
174 struct rte_flow_action_handle *handle; /**< Indirect action handle. */
175 enum age_action_context_type age_type; /**< Age action context type. */
176 /** If true, the action applies to "transfer" flows, and vice versa */
180 struct port_flow_tunnel {
181 LIST_ENTRY(port_flow_tunnel) chain;
182 struct rte_flow_action *pmd_actions;
183 struct rte_flow_item *pmd_items;
185 uint32_t num_pmd_actions;
186 uint32_t num_pmd_items;
187 struct rte_flow_tunnel tunnel;
188 struct rte_flow_action *actions;
189 struct rte_flow_item *items;
200 /** Information for an extended statistics to show. */
201 struct xstat_display_info {
202 /** Supported xstats IDs in the order of xstats_display */
205 uint64_t *prev_values;
206 uint64_t *curr_values;
212 * The data structure associated with each port.
215 struct rte_eth_dev_info dev_info; /**< PCI info + driver name */
216 struct rte_eth_conf dev_conf; /**< Port configuration. */
217 struct rte_ether_addr eth_addr; /**< Port ethernet address */
218 struct rte_eth_stats stats; /**< Last port statistics */
219 unsigned int socket_id; /**< For NUMA support */
220 uint16_t parse_tunnel:1; /**< Parse internal headers */
221 uint16_t tso_segsz; /**< Segmentation offload MSS for non-tunneled packets. */
222 uint16_t tunnel_tso_segsz; /**< Segmentation offload MSS for tunneled pkts. */
223 uint16_t tx_vlan_id;/**< The tag ID */
224 uint16_t tx_vlan_id_outer;/**< The outer tag ID */
225 volatile uint16_t port_status; /**< port started or not */
226 uint8_t need_setup; /**< port just attached */
227 uint8_t need_reconfig; /**< need reconfiguring port or not */
228 uint8_t need_reconfig_queues; /**< need reconfiguring queues or not */
229 uint8_t rss_flag; /**< enable rss or not */
230 uint8_t dcb_flag; /**< enable dcb */
231 uint16_t nb_rx_desc[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue rx desc number */
232 uint16_t nb_tx_desc[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue tx desc number */
233 struct rte_eth_rxconf rx_conf[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue rx configuration */
234 struct rte_eth_txconf tx_conf[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue tx configuration */
235 struct rte_ether_addr *mc_addr_pool; /**< pool of multicast addrs */
236 uint32_t mc_addr_nb; /**< nb. of addr. in mc_addr_pool */
237 uint8_t slave_flag; /**< bonding slave port */
238 struct port_flow *flow_list; /**< Associated flows. */
239 struct port_indirect_action *actions_list;
240 /**< Associated indirect actions. */
241 LIST_HEAD(, port_flow_tunnel) flow_tunnel_list;
242 const struct rte_eth_rxtx_callback *rx_dump_cb[RTE_MAX_QUEUES_PER_PORT+1];
243 const struct rte_eth_rxtx_callback *tx_dump_cb[RTE_MAX_QUEUES_PER_PORT+1];
244 /**< metadata value to insert in Tx packets. */
245 uint32_t tx_metadata;
246 const struct rte_eth_rxtx_callback *tx_set_md_cb[RTE_MAX_QUEUES_PER_PORT+1];
247 /**< dynamic flags. */
249 const struct rte_eth_rxtx_callback *tx_set_dynf_cb[RTE_MAX_QUEUES_PER_PORT+1];
250 /** Associated port which is supposed to handle "transfer" flows */
251 portid_t flow_transfer_proxy;
252 struct xstat_display_info xstats_info;
256 * The data structure associated with each forwarding logical core.
257 * The logical cores are internally numbered by a core index from 0 to
258 * the maximum number of logical cores - 1.
259 * The system CPU identifier of all logical cores are setup in a global
260 * CPU id. configuration table.
263 struct rte_gso_ctx gso_ctx; /**< GSO context */
264 struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
265 void *gro_ctx; /**< GRO context */
266 streamid_t stream_idx; /**< index of 1st stream in "fwd_streams" */
267 streamid_t stream_nb; /**< number of streams in "fwd_streams" */
268 lcoreid_t cpuid_idx; /**< index of logical core in CPU id table */
269 volatile char stopped; /**< stop forwarding when set */
273 * Forwarding mode operations:
274 * - IO forwarding mode (default mode)
275 * Forwards packets unchanged.
277 * - MAC forwarding mode
278 * Set the source and the destination Ethernet addresses of packets
279 * before forwarding them.
281 * - IEEE1588 forwarding mode
282 * Check that received IEEE1588 Precise Time Protocol (PTP) packets are
283 * filtered and timestamped by the hardware.
284 * Forwards packets unchanged on the same port.
285 * Check that sent IEEE1588 PTP packets are timestamped by the hardware.
287 typedef int (*port_fwd_begin_t)(portid_t pi);
288 typedef void (*port_fwd_end_t)(portid_t pi);
289 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
292 const char *fwd_mode_name; /**< Forwarding mode name. */
293 port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
294 port_fwd_end_t port_fwd_end; /**< NULL if nothing special to do. */
295 packet_fwd_t packet_fwd; /**< Mandatory. */
298 #define BURST_TX_WAIT_US 1
299 #define BURST_TX_RETRIES 64
301 extern uint32_t burst_tx_delay_time;
302 extern uint32_t burst_tx_retry_num;
304 extern struct fwd_engine io_fwd_engine;
305 extern struct fwd_engine mac_fwd_engine;
306 extern struct fwd_engine mac_swap_engine;
307 extern struct fwd_engine flow_gen_engine;
308 extern struct fwd_engine rx_only_engine;
309 extern struct fwd_engine tx_only_engine;
310 extern struct fwd_engine csum_fwd_engine;
311 extern struct fwd_engine icmp_echo_engine;
312 extern struct fwd_engine noisy_vnf_engine;
313 extern struct fwd_engine five_tuple_swap_fwd_engine;
314 #ifdef RTE_LIBRTE_IEEE1588
315 extern struct fwd_engine ieee1588_fwd_engine;
318 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
319 extern cmdline_parse_inst_t cmd_set_raw;
320 extern cmdline_parse_inst_t cmd_show_set_raw;
321 extern cmdline_parse_inst_t cmd_show_set_raw_all;
323 extern uint16_t mempool_flags;
326 * Forwarding Configuration
330 struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
331 streamid_t nb_fwd_streams; /**< Nb. of forward streams to process. */
332 lcoreid_t nb_fwd_lcores; /**< Nb. of logical cores to launch. */
333 portid_t nb_fwd_ports; /**< Nb. of ports involved. */
345 extern uint8_t xstats_hide_zero; /**< Hide zero values for xstats display */
347 /* globals used for configuration */
348 extern uint8_t record_core_cycles; /**< Enables measurement of CPU cycles */
349 extern uint8_t record_burst_stats; /**< Enables display of RX and TX bursts */
350 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
351 extern int testpmd_logtype; /**< Log type for testpmd logs */
352 extern uint8_t interactive;
353 extern uint8_t auto_start;
354 extern uint8_t tx_first;
355 extern char cmdline_filename[PATH_MAX]; /**< offline commands file */
356 extern uint8_t numa_support; /**< set by "--numa" parameter */
357 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
358 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
359 extern uint8_t flow_isolate_all; /**< set by "--flow-isolate-all */
360 extern uint8_t mp_alloc_type;
361 /**< set by "--mp-anon" or "--mp-alloc" parameter */
362 extern uint32_t eth_link_speed;
363 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
364 extern uint8_t no_device_start; /**<set by "--disable-device-start" parameter */
365 extern volatile int test_done; /* stop packet forwarding when set to 1. */
366 extern uint8_t lsc_interrupt; /**< disabled by "--no-lsc-interrupt" parameter */
367 extern uint8_t rmv_interrupt; /**< disabled by "--no-rmv-interrupt" parameter */
368 extern uint32_t event_print_mask;
369 /**< set by "--print-event xxxx" and "--mask-event xxxx parameters */
370 extern bool setup_on_probe_event; /**< disabled by port setup-on iterator */
371 extern uint8_t hot_plug; /**< enable by "--hot-plug" parameter */
372 extern int do_mlockall; /**< set by "--mlockall" or "--no-mlockall" parameter */
373 extern uint8_t clear_ptypes; /**< disabled by set ptype cmd */
375 #ifdef RTE_LIBRTE_IXGBE_BYPASS
376 extern uint32_t bypass_timeout; /**< Store the NIC bypass watchdog timeout */
380 * Store specified sockets on which memory pool to be used by ports
383 extern uint8_t port_numa[RTE_MAX_ETHPORTS];
386 * Store specified sockets on which RX ring to be used by ports
389 extern uint8_t rxring_numa[RTE_MAX_ETHPORTS];
392 * Store specified sockets on which TX ring to be used by ports
395 extern uint8_t txring_numa[RTE_MAX_ETHPORTS];
397 extern uint8_t socket_num;
400 * Configuration of logical cores:
401 * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
403 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
404 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
405 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
406 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
407 extern unsigned int num_sockets;
408 extern unsigned int socket_ids[RTE_MAX_NUMA_NODES];
411 * Configuration of Ethernet ports:
412 * nb_fwd_ports <= nb_cfg_ports <= nb_ports
414 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
415 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
416 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
417 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
418 extern struct rte_port *ports;
420 extern struct rte_eth_rxmode rx_mode;
421 extern struct rte_eth_txmode tx_mode;
423 extern uint64_t rss_hf;
425 extern queueid_t nb_hairpinq;
426 extern queueid_t nb_rxq;
427 extern queueid_t nb_txq;
429 extern uint16_t nb_rxd;
430 extern uint16_t nb_txd;
432 extern int16_t rx_free_thresh;
433 extern int8_t rx_drop_en;
434 extern int16_t tx_free_thresh;
435 extern int16_t tx_rs_thresh;
437 extern uint16_t noisy_tx_sw_bufsz;
438 extern uint16_t noisy_tx_sw_buf_flush_time;
439 extern uint64_t noisy_lkup_mem_sz;
440 extern uint64_t noisy_lkup_num_writes;
441 extern uint64_t noisy_lkup_num_reads;
442 extern uint64_t noisy_lkup_num_reads_writes;
444 extern uint8_t dcb_config;
446 extern uint32_t mbuf_data_size_n;
447 extern uint16_t mbuf_data_size[MAX_SEGS_BUFFER_SPLIT];
448 /**< Mbuf data space size. */
449 extern uint32_t param_total_num_mbufs;
451 extern uint16_t stats_period;
453 extern struct rte_eth_xstat_name *xstats_display;
454 extern unsigned int xstats_display_num;
456 extern uint16_t hairpin_mode;
458 #ifdef RTE_LIB_LATENCYSTATS
459 extern uint8_t latencystats_enabled;
460 extern lcoreid_t latencystats_lcore_id;
463 #ifdef RTE_LIB_BITRATESTATS
464 extern lcoreid_t bitrate_lcore_id;
465 extern uint8_t bitrate_enabled;
468 extern struct rte_fdir_conf fdir_conf;
470 extern uint32_t max_rx_pkt_len;
473 * Configuration of packet segments used to scatter received packets
474 * if some of split features is configured.
476 extern uint16_t rx_pkt_seg_lengths[MAX_SEGS_BUFFER_SPLIT];
477 extern uint8_t rx_pkt_nb_segs; /**< Number of segments to split */
478 extern uint16_t rx_pkt_seg_offsets[MAX_SEGS_BUFFER_SPLIT];
479 extern uint8_t rx_pkt_nb_offs; /**< Number of specified offsets */
482 * Configuration of packet segments used by the "txonly" processing engine.
484 #define TXONLY_DEF_PACKET_LEN 64
485 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
486 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
487 extern uint8_t tx_pkt_nb_segs; /**< Number of segments in TX packets */
488 extern uint32_t tx_pkt_times_intra;
489 extern uint32_t tx_pkt_times_inter;
497 extern enum tx_pkt_split tx_pkt_split;
499 extern uint8_t txonly_multi_flow;
501 extern uint16_t nb_pkt_per_burst;
502 extern uint16_t nb_pkt_flowgen_clones;
503 extern int nb_flows_flowgen;
504 extern uint16_t mb_mempool_cache;
505 extern int8_t rx_pthresh;
506 extern int8_t rx_hthresh;
507 extern int8_t rx_wthresh;
508 extern int8_t tx_pthresh;
509 extern int8_t tx_hthresh;
510 extern int8_t tx_wthresh;
512 extern uint16_t tx_udp_src_port;
513 extern uint16_t tx_udp_dst_port;
515 extern uint32_t tx_ip_src_addr;
516 extern uint32_t tx_ip_dst_addr;
518 extern struct fwd_config cur_fwd_config;
519 extern struct fwd_engine *cur_fwd_eng;
520 extern uint32_t retry_enabled;
521 extern struct fwd_lcore **fwd_lcores;
522 extern struct fwd_stream **fwd_streams;
524 extern uint16_t vxlan_gpe_udp_port; /**< UDP port of tunnel VXLAN-GPE. */
525 extern uint16_t geneve_udp_port; /**< UDP port of tunnel GENEVE. */
527 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
528 extern struct rte_ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
530 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
531 extern uint32_t burst_tx_retry_num; /**< Burst tx retry number for mac-retry. */
533 #define GRO_DEFAULT_ITEM_NUM_PER_FLOW 32
534 #define GRO_DEFAULT_FLOW_NUM (RTE_GRO_MAX_BURST_ITEM_NUM / \
535 GRO_DEFAULT_ITEM_NUM_PER_FLOW)
537 #define GRO_DEFAULT_FLUSH_CYCLES 1
538 #define GRO_MAX_FLUSH_CYCLES 4
541 struct rte_gro_param param;
544 extern struct gro_status gro_ports[RTE_MAX_ETHPORTS];
545 extern uint8_t gro_flush_cycles;
547 #define GSO_MAX_PKT_BURST 2048
551 extern struct gso_status gso_ports[RTE_MAX_ETHPORTS];
552 extern uint16_t gso_max_segment_size;
554 /* VXLAN encap/decap parameters. */
555 struct vxlan_encap_conf {
556 uint32_t select_ipv4:1;
557 uint32_t select_vlan:1;
558 uint32_t select_tos_ttl:1;
564 uint8_t ipv6_src[16];
565 uint8_t ipv6_dst[16];
569 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
570 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
573 extern struct vxlan_encap_conf vxlan_encap_conf;
575 /* NVGRE encap/decap parameters. */
576 struct nvgre_encap_conf {
577 uint32_t select_ipv4:1;
578 uint32_t select_vlan:1;
582 uint8_t ipv6_src[16];
583 uint8_t ipv6_dst[16];
585 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
586 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
589 extern struct nvgre_encap_conf nvgre_encap_conf;
591 /* L2 encap parameters. */
592 struct l2_encap_conf {
593 uint32_t select_ipv4:1;
594 uint32_t select_vlan:1;
596 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
597 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
599 extern struct l2_encap_conf l2_encap_conf;
601 /* L2 decap parameters. */
602 struct l2_decap_conf {
603 uint32_t select_vlan:1;
605 extern struct l2_decap_conf l2_decap_conf;
607 /* MPLSoGRE encap parameters. */
608 struct mplsogre_encap_conf {
609 uint32_t select_ipv4:1;
610 uint32_t select_vlan:1;
614 uint8_t ipv6_src[16];
615 uint8_t ipv6_dst[16];
617 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
618 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
620 extern struct mplsogre_encap_conf mplsogre_encap_conf;
622 /* MPLSoGRE decap parameters. */
623 struct mplsogre_decap_conf {
624 uint32_t select_ipv4:1;
625 uint32_t select_vlan:1;
627 extern struct mplsogre_decap_conf mplsogre_decap_conf;
629 /* MPLSoUDP encap parameters. */
630 struct mplsoudp_encap_conf {
631 uint32_t select_ipv4:1;
632 uint32_t select_vlan:1;
638 uint8_t ipv6_src[16];
639 uint8_t ipv6_dst[16];
641 uint8_t eth_src[RTE_ETHER_ADDR_LEN];
642 uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
644 extern struct mplsoudp_encap_conf mplsoudp_encap_conf;
646 /* MPLSoUDP decap parameters. */
647 struct mplsoudp_decap_conf {
648 uint32_t select_ipv4:1;
649 uint32_t select_vlan:1;
651 extern struct mplsoudp_decap_conf mplsoudp_decap_conf;
653 extern enum rte_eth_rx_mq_mode rx_mq_mode;
655 extern struct rte_flow_action_conntrack conntrack_context;
658 extern unsigned int num_procs;
661 is_proc_primary(void)
663 return rte_eal_process_type() == RTE_PROC_PRIMARY;
666 static inline unsigned int
671 for (i = 0; i < RTE_MAX_LCORE; ++i)
672 if (fwd_lcores_cpuids[i] == rte_lcore_id())
675 rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
679 parse_fwd_portlist(const char *port);
681 static inline struct fwd_lcore *
682 current_fwd_lcore(void)
684 return fwd_lcores[lcore_num()];
689 mbuf_poolname_build(unsigned int sock_id, char *mp_name,
690 int name_size, uint16_t idx)
693 snprintf(mp_name, name_size,
694 MBUF_POOL_NAME_PFX "_%u", sock_id);
696 snprintf(mp_name, name_size,
697 MBUF_POOL_NAME_PFX "_%hu_%hu", (uint16_t)sock_id, idx);
700 static inline struct rte_mempool *
701 mbuf_pool_find(unsigned int sock_id, uint16_t idx)
703 char pool_name[RTE_MEMPOOL_NAMESIZE];
705 mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name), idx);
706 return rte_mempool_lookup((const char *)pool_name);
710 * Read/Write operations on a PCI register of a port.
712 static inline uint32_t
713 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
715 const struct rte_pci_device *pci_dev;
716 const struct rte_bus *bus;
720 if (!port->dev_info.device) {
721 fprintf(stderr, "Invalid device\n");
725 bus = rte_bus_find_by_device(port->dev_info.device);
726 if (bus && !strcmp(bus->name, "pci")) {
727 pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
729 fprintf(stderr, "Not a PCI device\n");
733 reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
734 reg_v = *((volatile uint32_t *)reg_addr);
735 return rte_le_to_cpu_32(reg_v);
738 #define port_id_pci_reg_read(pt_id, reg_off) \
739 port_pci_reg_read(&ports[(pt_id)], (reg_off))
742 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
744 const struct rte_pci_device *pci_dev;
745 const struct rte_bus *bus;
748 if (!port->dev_info.device) {
749 fprintf(stderr, "Invalid device\n");
753 bus = rte_bus_find_by_device(port->dev_info.device);
754 if (bus && !strcmp(bus->name, "pci")) {
755 pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
757 fprintf(stderr, "Not a PCI device\n");
761 reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
762 *((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
765 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
766 port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
769 get_start_cycles(uint64_t *start_tsc)
771 if (record_core_cycles)
772 *start_tsc = rte_rdtsc();
776 get_end_cycles(struct fwd_stream *fs, uint64_t start_tsc)
778 if (record_core_cycles)
779 fs->core_cycles += rte_rdtsc() - start_tsc;
783 inc_rx_burst_stats(struct fwd_stream *fs, uint16_t nb_rx)
785 if (record_burst_stats)
786 fs->rx_burst_stats.pkt_burst_spread[nb_rx]++;
790 inc_tx_burst_stats(struct fwd_stream *fs, uint16_t nb_tx)
792 if (record_burst_stats)
793 fs->tx_burst_stats.pkt_burst_spread[nb_tx]++;
797 unsigned int parse_item_list(const char *str, const char *item_name,
798 unsigned int max_items,
799 unsigned int *parsed_items, int check_unique_values);
800 void launch_args_parse(int argc, char** argv);
801 void cmdline_read_from_file(const char *filename);
803 void prompt_exit(void);
804 void nic_stats_display(portid_t port_id);
805 void nic_stats_clear(portid_t port_id);
806 void nic_xstats_display(portid_t port_id);
807 void nic_xstats_clear(portid_t port_id);
808 void device_infos_display(const char *identifier);
809 void port_infos_display(portid_t port_id);
810 void port_summary_display(portid_t port_id);
811 void port_eeprom_display(portid_t port_id);
812 void port_module_eeprom_display(portid_t port_id);
813 void port_summary_header_display(void);
814 void rx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
815 void tx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
816 void fwd_lcores_config_display(void);
817 void pkt_fwd_config_display(struct fwd_config *cfg);
818 void rxtx_config_display(void);
819 void fwd_config_setup(void);
820 void set_def_fwd_config(void);
821 void reconfig(portid_t new_port_id, unsigned socket_id);
822 int init_fwd_streams(void);
823 void update_fwd_ports(portid_t new_pid);
825 void set_fwd_eth_peer(portid_t port_id, char *peer_addr);
827 void port_mtu_set(portid_t port_id, uint16_t mtu);
828 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
829 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
831 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
832 uint8_t bit1_pos, uint8_t bit2_pos);
833 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
834 uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
835 void port_reg_display(portid_t port_id, uint32_t reg_off);
836 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
837 int port_action_handle_create(portid_t port_id, uint32_t id,
838 const struct rte_flow_indir_action_conf *conf,
839 const struct rte_flow_action *action);
840 int port_action_handle_destroy(portid_t port_id,
841 uint32_t n, const uint32_t *action);
842 struct rte_flow_action_handle *port_action_handle_get_by_id(portid_t port_id,
844 int port_action_handle_update(portid_t port_id, uint32_t id,
845 const struct rte_flow_action *action);
846 int port_flow_validate(portid_t port_id,
847 const struct rte_flow_attr *attr,
848 const struct rte_flow_item *pattern,
849 const struct rte_flow_action *actions,
850 const struct tunnel_ops *tunnel_ops);
851 int port_flow_create(portid_t port_id,
852 const struct rte_flow_attr *attr,
853 const struct rte_flow_item *pattern,
854 const struct rte_flow_action *actions,
855 const struct tunnel_ops *tunnel_ops);
856 int port_action_handle_query(portid_t port_id, uint32_t id);
857 void update_age_action_context(const struct rte_flow_action *actions,
858 struct port_flow *pf);
859 int port_flow_destroy(portid_t port_id, uint32_t n, const uint32_t *rule);
860 int port_flow_flush(portid_t port_id);
861 int port_flow_dump(portid_t port_id, bool dump_all,
862 uint32_t rule, const char *file_name);
863 int port_flow_query(portid_t port_id, uint32_t rule,
864 const struct rte_flow_action *action);
865 void port_flow_list(portid_t port_id, uint32_t n, const uint32_t *group);
866 void port_flow_aged(portid_t port_id, uint8_t destroy);
867 const char *port_flow_tunnel_type(struct rte_flow_tunnel *tunnel);
868 struct port_flow_tunnel *
869 port_flow_locate_tunnel(uint16_t port_id, struct rte_flow_tunnel *tun);
870 void port_flow_tunnel_list(portid_t port_id);
871 void port_flow_tunnel_destroy(portid_t port_id, uint32_t tunnel_id);
872 void port_flow_tunnel_create(portid_t port_id, const struct tunnel_ops *ops);
873 int port_flow_isolate(portid_t port_id, int set);
874 int port_meter_policy_add(portid_t port_id, uint32_t policy_id,
875 const struct rte_flow_action *actions);
877 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
878 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
880 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
881 int set_fwd_lcores_mask(uint64_t lcoremask);
882 void set_fwd_lcores_number(uint16_t nb_lc);
884 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
885 void set_fwd_ports_mask(uint64_t portmask);
886 void set_fwd_ports_number(uint16_t nb_pt);
887 int port_is_forwarding(portid_t port_id);
889 void rx_vlan_strip_set(portid_t port_id, int on);
890 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
892 void rx_vlan_filter_set(portid_t port_id, int on);
893 void rx_vlan_all_filter_set(portid_t port_id, int on);
894 void rx_vlan_qinq_strip_set(portid_t port_id, int on);
895 int rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
896 void vlan_extend_set(portid_t port_id, int on);
897 void vlan_tpid_set(portid_t port_id, enum rte_vlan_type vlan_type,
899 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
900 void tx_qinq_set(portid_t port_id, uint16_t vlan_id, uint16_t vlan_id_outer);
901 void tx_vlan_reset(portid_t port_id);
902 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
904 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
906 void set_xstats_hide_zero(uint8_t on_off);
908 void set_record_core_cycles(uint8_t on_off);
909 void set_record_burst_stats(uint8_t on_off);
910 void set_verbose_level(uint16_t vb_level);
911 void set_rx_pkt_segments(unsigned int *seg_lengths, unsigned int nb_segs);
912 void show_rx_pkt_segments(void);
913 void set_rx_pkt_offsets(unsigned int *seg_offsets, unsigned int nb_offs);
914 void show_rx_pkt_offsets(void);
915 void set_tx_pkt_segments(unsigned int *seg_lengths, unsigned int nb_segs);
916 void show_tx_pkt_segments(void);
917 void set_tx_pkt_times(unsigned int *tx_times);
918 void show_tx_pkt_times(void);
919 void set_tx_pkt_split(const char *name);
920 int parse_fec_mode(const char *name, uint32_t *fec_capa);
921 void show_fec_capability(uint32_t num, struct rte_eth_fec_capa *speed_fec_capa);
922 void set_nb_pkt_per_burst(uint16_t pkt_burst);
923 char *list_pkt_forwarding_modes(void);
924 char *list_pkt_forwarding_retry_modes(void);
925 void set_pkt_forwarding_mode(const char *fwd_mode);
926 void start_packet_forwarding(int with_tx_first);
927 void fwd_stats_display(void);
928 void fwd_stats_reset(void);
929 void stop_packet_forwarding(void);
930 void dev_set_link_up(portid_t pid);
931 void dev_set_link_down(portid_t pid);
932 void init_port_config(void);
933 void set_port_slave_flag(portid_t slave_pid);
934 void clear_port_slave_flag(portid_t slave_pid);
935 uint8_t port_is_bonding_slave(portid_t slave_pid);
937 int init_port_dcb_config(portid_t pid, enum dcb_mode_enable dcb_mode,
938 enum rte_eth_nb_tcs num_tcs,
940 int start_port(portid_t pid);
941 void stop_port(portid_t pid);
942 void close_port(portid_t pid);
943 void reset_port(portid_t pid);
944 void attach_port(char *identifier);
945 void detach_devargs(char *identifier);
946 void detach_port_device(portid_t port_id);
947 int all_ports_stopped(void);
948 int port_is_stopped(portid_t port_id);
949 int port_is_started(portid_t port_id);
950 void pmd_test_exit(void);
951 #if defined(RTE_NET_I40E) || defined(RTE_NET_IXGBE)
952 void fdir_get_infos(portid_t port_id);
954 void fdir_set_flex_mask(portid_t port_id,
955 struct rte_eth_fdir_flex_mask *cfg);
956 void fdir_set_flex_payload(portid_t port_id,
957 struct rte_eth_flex_payload_cfg *cfg);
958 void port_rss_reta_info(portid_t port_id,
959 struct rte_eth_rss_reta_entry64 *reta_conf,
960 uint16_t nb_entries);
962 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
965 rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
966 uint16_t nb_rx_desc, unsigned int socket_id,
967 struct rte_eth_rxconf *rx_conf, struct rte_mempool *mp);
969 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
970 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
973 void port_rss_hash_conf_show(portid_t port_id, int show_rss_key);
974 void port_rss_hash_key_update(portid_t port_id, char rss_type[],
975 uint8_t *hash_key, uint8_t hash_key_len);
976 int rx_queue_id_is_invalid(queueid_t rxq_id);
977 int tx_queue_id_is_invalid(queueid_t txq_id);
978 void setup_gro(const char *onoff, portid_t port_id);
979 void setup_gro_flush_cycles(uint8_t cycles);
980 void show_gro(portid_t port_id);
981 void setup_gso(const char *mode, portid_t port_id);
982 int eth_dev_info_get_print_err(uint16_t port_id,
983 struct rte_eth_dev_info *dev_info);
984 int eth_dev_conf_get_print_err(uint16_t port_id,
985 struct rte_eth_conf *dev_conf);
986 void eth_set_promisc_mode(uint16_t port_id, int enable);
987 void eth_set_allmulticast_mode(uint16_t port, int enable);
988 int eth_link_get_nowait_print_err(uint16_t port_id, struct rte_eth_link *link);
989 int eth_macaddr_get_print_err(uint16_t port_id,
990 struct rte_ether_addr *mac_addr);
992 /* Functions to display the set of MAC addresses added to a port*/
993 void show_macs(portid_t port_id);
994 void show_mcast_macs(portid_t port_id);
996 /* Functions to manage the set of filtered Multicast MAC addresses */
997 void mcast_addr_add(portid_t port_id, struct rte_ether_addr *mc_addr);
998 void mcast_addr_remove(portid_t port_id, struct rte_ether_addr *mc_addr);
999 void port_dcb_info_display(portid_t port_id);
1001 uint8_t *open_file(const char *file_path, uint32_t *size);
1002 int save_file(const char *file_path, uint8_t *buf, uint32_t size);
1003 int close_file(uint8_t *buf);
1005 void port_queue_region_info_display(portid_t port_id, void *buf);
1007 enum print_warning {
1011 int port_id_is_invalid(portid_t port_id, enum print_warning warning);
1012 void print_valid_ports(void);
1013 int new_socket_id(unsigned int socket_id);
1015 queueid_t get_allowed_max_nb_rxq(portid_t *pid);
1016 int check_nb_rxq(queueid_t rxq);
1017 queueid_t get_allowed_max_nb_txq(portid_t *pid);
1018 int check_nb_txq(queueid_t txq);
1019 int check_nb_rxd(queueid_t rxd);
1020 int check_nb_txd(queueid_t txd);
1021 queueid_t get_allowed_max_nb_hairpinq(portid_t *pid);
1022 int check_nb_hairpinq(queueid_t hairpinq);
1024 uint16_t dump_rx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
1025 uint16_t nb_pkts, __rte_unused uint16_t max_pkts,
1026 __rte_unused void *user_param);
1028 uint16_t dump_tx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
1029 uint16_t nb_pkts, __rte_unused void *user_param);
1031 void add_rx_dump_callbacks(portid_t portid);
1032 void remove_rx_dump_callbacks(portid_t portid);
1033 void add_tx_dump_callbacks(portid_t portid);
1034 void remove_tx_dump_callbacks(portid_t portid);
1035 void configure_rxtx_dump_callbacks(uint16_t verbose);
1037 uint16_t tx_pkt_set_md(uint16_t port_id, __rte_unused uint16_t queue,
1038 struct rte_mbuf *pkts[], uint16_t nb_pkts,
1039 __rte_unused void *user_param);
1040 void add_tx_md_callback(portid_t portid);
1041 void remove_tx_md_callback(portid_t portid);
1043 uint16_t tx_pkt_set_dynf(uint16_t port_id, __rte_unused uint16_t queue,
1044 struct rte_mbuf *pkts[], uint16_t nb_pkts,
1045 __rte_unused void *user_param);
1046 void add_tx_dynf_callback(portid_t portid);
1047 void remove_tx_dynf_callback(portid_t portid);
1048 int update_jumbo_frame_offload(portid_t portid, uint32_t max_rx_pktlen);
1051 * Work-around of a compilation error with ICC on invocations of the
1052 * rte_be_to_cpu_16() function.
1055 #define RTE_BE_TO_CPU_16(be_16_v) rte_be_to_cpu_16((be_16_v))
1056 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
1058 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
1059 #define RTE_BE_TO_CPU_16(be_16_v) (be_16_v)
1060 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
1062 #define RTE_BE_TO_CPU_16(be_16_v) \
1063 (uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
1064 #define RTE_CPU_TO_BE_16(cpu_16_v) \
1065 (uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
1067 #endif /* __GCC__ */
1069 #define TESTPMD_LOG(level, fmt, args...) \
1070 rte_log(RTE_LOG_ ## level, testpmd_logtype, "testpmd: " fmt, ## args)
1072 #endif /* _TESTPMD_H_ */