4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 /* icc on baremetal gives us troubles with function named 'main' */
38 #ifdef RTE_EXEC_ENV_BAREMETAL
40 int main(int argc, char **argv);
43 #define RTE_PORT_ALL (~(portid_t)0x0)
45 #define RTE_TEST_RX_DESC_MAX 2048
46 #define RTE_TEST_TX_DESC_MAX 2048
48 #define RTE_PORT_STOPPED (uint16_t)0
49 #define RTE_PORT_STARTED (uint16_t)1
50 #define RTE_PORT_CLOSED (uint16_t)2
51 #define RTE_PORT_HANDLING (uint16_t)3
54 * Default size of the mbuf data buffer to receive standard 1518-byte
55 * Ethernet frames in a mono-segment memory buffer.
57 #define DEFAULT_MBUF_DATA_SIZE 2048 /**< Default size of mbuf data buffer. */
60 * The maximum number of segments per packet is used when creating
61 * scattered transmit packets composed of a list of mbufs.
63 #define RTE_MAX_SEGS_PER_PKT 255 /**< pkt.nb_segs is a 8-bit unsigned char. */
65 #define MAX_PKT_BURST 512
66 #define DEF_PKT_BURST 16
68 #define CACHE_LINE_SIZE_ROUNDUP(size) \
69 (CACHE_LINE_SIZE * ((size + CACHE_LINE_SIZE - 1) / CACHE_LINE_SIZE))
71 #define NUMA_NO_CONFIG 0xFF
72 #define UMA_NO_CONFIG 0xFF
74 typedef uint8_t lcoreid_t;
75 typedef uint8_t portid_t;
76 typedef uint16_t queueid_t;
77 typedef uint16_t streamid_t;
79 #define MAX_QUEUE_ID ((1 << (sizeof(queueid_t) * 8)) - 1)
83 PORT_TOPOLOGY_CHAINED,
87 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
89 * The data structure associated with RX and TX packet burst statistics
90 * that are recorded for each forwarding stream.
92 struct pkt_burst_stats {
93 unsigned int pkt_burst_spread[MAX_PKT_BURST];
98 * The data structure associated with a forwarding stream between a receive
99 * port/queue and a transmit port/queue.
102 /* "read-only" data */
103 portid_t rx_port; /**< port to poll for received packets */
104 queueid_t rx_queue; /**< RX queue to poll on "rx_port" */
105 portid_t tx_port; /**< forwarding port of received packets */
106 queueid_t tx_queue; /**< TX queue to send forwarded packets */
107 streamid_t peer_addr; /**< index of peer ethernet address of packets */
109 /* "read-write" results */
110 unsigned int rx_packets; /**< received packets */
111 unsigned int tx_packets; /**< received packets transmitted */
112 unsigned int fwd_dropped; /**< received packets not forwarded */
113 unsigned int rx_bad_ip_csum ; /**< received packets has bad ip checksum */
114 unsigned int rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
115 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
116 uint64_t core_cycles; /**< used for RX and TX processing */
118 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
119 struct pkt_burst_stats rx_burst_stats;
120 struct pkt_burst_stats tx_burst_stats;
125 * The data structure associated with each port.
126 * tx_ol_flags is slightly different from ol_flags of rte_mbuf.
127 * Bit 0: Insert IP checksum
128 * Bit 1: Insert UDP checksum
129 * Bit 2: Insert TCP checksum
130 * Bit 3: Insert SCTP checksum
131 * Bit 11: Insert VLAN Label
134 struct rte_eth_dev_info dev_info; /**< PCI info + driver name */
135 struct rte_eth_conf dev_conf; /**< Port configuration. */
136 struct ether_addr eth_addr; /**< Port ethernet address */
137 struct rte_eth_stats stats; /**< Last port statistics */
138 uint64_t tx_dropped; /**< If no descriptor in TX ring */
139 struct fwd_stream *rx_stream; /**< Port RX stream, if unique */
140 struct fwd_stream *tx_stream; /**< Port TX stream, if unique */
141 unsigned int socket_id; /**< For NUMA support */
142 uint16_t tx_ol_flags;/**< Offload Flags of TX packets. */
143 uint16_t tx_vlan_id; /**< Tag Id. in TX VLAN packets. */
144 void *fwd_ctx; /**< Forwarding mode context */
145 uint64_t rx_bad_ip_csum; /**< rx pkts with bad ip checksum */
146 uint64_t rx_bad_l4_csum; /**< rx pkts with bad l4 checksum */
147 uint8_t tx_queue_stats_mapping_enabled;
148 uint8_t rx_queue_stats_mapping_enabled;
149 volatile uint16_t port_status; /**< port started or not */
150 uint8_t need_reconfig; /**< need reconfiguring port or not */
151 uint8_t need_reconfig_queues; /**< need reconfiguring queues or not */
152 uint8_t rss_flag; /**< enable rss or not */
153 uint8_t dcb_flag; /**< enable dcb */
154 struct rte_eth_rxconf rx_conf; /**< rx configuration */
155 struct rte_eth_txconf tx_conf; /**< tx configuration */
159 * The data structure associated with each forwarding logical core.
160 * The logical cores are internally numbered by a core index from 0 to
161 * the maximum number of logical cores - 1.
162 * The system CPU identifier of all logical cores are setup in a global
163 * CPU id. configuration table.
166 struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
167 streamid_t stream_idx; /**< index of 1st stream in "fwd_streams" */
168 streamid_t stream_nb; /**< number of streams in "fwd_streams" */
169 lcoreid_t cpuid_idx; /**< index of logical core in CPU id table */
170 queueid_t tx_queue; /**< TX queue to send forwarded packets */
171 volatile char stopped; /**< stop forwarding when set */
175 * Forwarding mode operations:
176 * - IO forwarding mode (default mode)
177 * Forwards packets unchanged.
179 * - MAC forwarding mode
180 * Set the source and the destination Ethernet addresses of packets
181 * before forwarding them.
183 * - IEEE1588 forwarding mode
184 * Check that received IEEE1588 Precise Time Protocol (PTP) packets are
185 * filtered and timestamped by the hardware.
186 * Forwards packets unchanged on the same port.
187 * Check that sent IEEE1588 PTP packets are timestamped by the hardware.
189 typedef void (*port_fwd_begin_t)(portid_t pi);
190 typedef void (*port_fwd_end_t)(portid_t pi);
191 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
194 const char *fwd_mode_name; /**< Forwarding mode name. */
195 port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
196 port_fwd_end_t port_fwd_end; /**< NULL if nothing special to do. */
197 packet_fwd_t packet_fwd; /**< Mandatory. */
200 extern struct fwd_engine io_fwd_engine;
201 extern struct fwd_engine mac_fwd_engine;
202 extern struct fwd_engine mac_retry_fwd_engine;
203 extern struct fwd_engine mac_swap_engine;
204 extern struct fwd_engine flow_gen_engine;
205 extern struct fwd_engine rx_only_engine;
206 extern struct fwd_engine tx_only_engine;
207 extern struct fwd_engine csum_fwd_engine;
208 extern struct fwd_engine icmp_echo_engine;
209 #ifdef RTE_LIBRTE_IEEE1588
210 extern struct fwd_engine ieee1588_fwd_engine;
213 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
216 * Forwarding Configuration
220 struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
221 streamid_t nb_fwd_streams; /**< Nb. of forward streams to process. */
222 lcoreid_t nb_fwd_lcores; /**< Nb. of logical cores to launch. */
223 portid_t nb_fwd_ports; /**< Nb. of ports involved. */
236 * DCB general config info
239 enum dcb_mode_enable dcb_mode;
241 enum rte_eth_nb_tcs num_tcs;
246 * In DCB io FWD mode, 128 RX queue to 128 TX queue mapping
248 enum dcb_queue_mapping_mode {
249 DCB_VT_Q_MAPPING = 0,
254 #define MAX_TX_QUEUE_STATS_MAPPINGS 1024 /* MAX_PORT of 32 @ 32 tx_queues/port */
255 #define MAX_RX_QUEUE_STATS_MAPPINGS 4096 /* MAX_PORT of 32 @ 128 rx_queues/port */
257 struct queue_stats_mappings {
260 uint8_t stats_counter_id;
261 } __rte_cache_aligned;
263 extern struct queue_stats_mappings tx_queue_stats_mappings_array[];
264 extern struct queue_stats_mappings rx_queue_stats_mappings_array[];
266 /* Assign both tx and rx queue stats mappings to the same default values */
267 extern struct queue_stats_mappings *tx_queue_stats_mappings;
268 extern struct queue_stats_mappings *rx_queue_stats_mappings;
270 extern uint16_t nb_tx_queue_stats_mappings;
271 extern uint16_t nb_rx_queue_stats_mappings;
273 /* globals used for configuration */
274 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
275 extern uint8_t interactive;
276 extern uint8_t auto_start;
277 extern uint8_t numa_support; /**< set by "--numa" parameter */
278 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
279 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
280 extern uint8_t mp_anon; /**< set by "--mp-anon" parameter */
281 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
283 #ifdef RTE_NIC_BYPASS
284 extern uint32_t bypass_timeout; /**< Store the NIC bypass watchdog timeout */
287 #define MAX_SOCKET 2 /*MAX SOCKET:currently, it is 2 */
290 * Store specified sockets on which memory pool to be used by ports
293 uint8_t port_numa[RTE_MAX_ETHPORTS];
296 * Store specified sockets on which RX ring to be used by ports
299 uint8_t rxring_numa[RTE_MAX_ETHPORTS];
302 * Store specified sockets on which TX ring to be used by ports
305 uint8_t txring_numa[RTE_MAX_ETHPORTS];
307 extern uint8_t socket_num;
310 * Configuration of logical cores:
311 * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
313 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
314 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
315 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
316 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
319 * Configuration of Ethernet ports:
320 * nb_fwd_ports <= nb_cfg_ports <= nb_ports
322 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
323 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
324 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
325 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
326 extern struct rte_port *ports;
328 extern struct rte_eth_rxmode rx_mode;
329 extern uint64_t rss_hf;
331 extern queueid_t nb_rxq;
332 extern queueid_t nb_txq;
334 extern uint16_t nb_rxd;
335 extern uint16_t nb_txd;
337 extern uint16_t rx_free_thresh;
338 extern uint8_t rx_drop_en;
339 extern uint16_t tx_free_thresh;
340 extern uint16_t tx_rs_thresh;
341 extern uint32_t txq_flags;
343 extern uint8_t dcb_config;
344 extern uint8_t dcb_test;
345 extern enum dcb_queue_mapping_mode dcb_q_mapping;
347 extern uint16_t mbuf_data_size; /**< Mbuf data space size. */
348 extern uint32_t param_total_num_mbufs;
350 extern struct rte_fdir_conf fdir_conf;
353 * Configuration of packet segments used by the "txonly" processing engine.
355 #define TXONLY_DEF_PACKET_LEN 64
356 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
357 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
358 extern uint8_t tx_pkt_nb_segs; /**< Number of segments in TX packets */
360 extern uint16_t nb_pkt_per_burst;
361 extern uint16_t mb_mempool_cache;
362 extern struct rte_eth_thresh rx_thresh;
363 extern struct rte_eth_thresh tx_thresh;
365 extern struct fwd_config cur_fwd_config;
366 extern struct fwd_engine *cur_fwd_eng;
367 extern struct fwd_lcore **fwd_lcores;
368 extern struct fwd_stream **fwd_streams;
370 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
371 extern struct ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
373 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
374 extern uint32_t burst_tx_retry_num; /**< Burst tx retry number for mac-retry. */
376 static inline unsigned int
381 for (i = 0; i < RTE_MAX_LCORE; ++i)
382 if (fwd_lcores_cpuids[i] == rte_lcore_id())
385 rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
388 static inline struct fwd_lcore *
389 current_fwd_lcore(void)
391 return fwd_lcores[lcore_num()];
396 mbuf_poolname_build(unsigned int sock_id, char* mp_name, int name_size)
398 rte_snprintf(mp_name, name_size, "mbuf_pool_socket_%u", sock_id);
401 static inline struct rte_mempool *
402 mbuf_pool_find(unsigned int sock_id)
404 char pool_name[RTE_MEMPOOL_NAMESIZE];
406 mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name));
407 return (rte_mempool_lookup((const char *)pool_name));
411 * Read/Write operations on a PCI register of a port.
413 static inline uint32_t
414 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
420 ((char *)port->dev_info.pci_dev->mem_resource[0].addr +
422 reg_v = *((volatile uint32_t *)reg_addr);
423 return rte_le_to_cpu_32(reg_v);
426 #define port_id_pci_reg_read(pt_id, reg_off) \
427 port_pci_reg_read(&ports[(pt_id)], (reg_off))
430 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
435 ((char *)port->dev_info.pci_dev->mem_resource[0].addr +
437 *((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
440 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
441 port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
444 void launch_args_parse(int argc, char** argv);
446 void nic_stats_display(portid_t port_id);
447 void nic_stats_clear(portid_t port_id);
448 void nic_stats_mapping_display(portid_t port_id);
449 void port_infos_display(portid_t port_id);
450 void fwd_lcores_config_display(void);
451 void fwd_config_display(void);
452 void rxtx_config_display(void);
453 void fwd_config_setup(void);
454 void set_def_fwd_config(void);
455 int init_fwd_streams(void);
457 void port_mtu_set(portid_t port_id, uint16_t mtu);
458 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
459 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
461 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
462 uint8_t bit1_pos, uint8_t bit2_pos);
463 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
464 uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
465 void port_reg_display(portid_t port_id, uint32_t reg_off);
466 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
468 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
469 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
471 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
472 int set_fwd_lcores_mask(uint64_t lcoremask);
473 void set_fwd_lcores_number(uint16_t nb_lc);
475 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
476 void set_fwd_ports_mask(uint64_t portmask);
477 void set_fwd_ports_number(uint16_t nb_pt);
479 void rx_vlan_strip_set(portid_t port_id, int on);
480 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
482 void rx_vlan_filter_set(portid_t port_id, int on);
483 void rx_vlan_all_filter_set(portid_t port_id, int on);
484 void rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
485 void vlan_extend_set(portid_t port_id, int on);
486 void vlan_tpid_set(portid_t port_id, uint16_t tp_id);
487 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
488 void tx_vlan_reset(portid_t port_id);
489 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
491 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
493 void tx_cksum_set(portid_t port_id, uint8_t cksum_mask);
495 void set_verbose_level(uint16_t vb_level);
496 void set_tx_pkt_segments(unsigned *seg_lengths, unsigned nb_segs);
497 void set_nb_pkt_per_burst(uint16_t pkt_burst);
498 char *list_pkt_forwarding_modes(void);
499 void set_pkt_forwarding_mode(const char *fwd_mode);
500 void start_packet_forwarding(int with_tx_first);
501 void stop_packet_forwarding(void);
502 void dev_set_link_up(portid_t pid);
503 void dev_set_link_down(portid_t pid);
504 void init_port_config(void);
505 int init_port_dcb_config(portid_t pid,struct dcb_config *dcb_conf);
506 int start_port(portid_t pid);
507 void stop_port(portid_t pid);
508 void close_port(portid_t pid);
509 int all_ports_stopped(void);
510 void pmd_test_exit(void);
512 void fdir_add_signature_filter(portid_t port_id, uint8_t queue_id,
513 struct rte_fdir_filter *fdir_filter);
514 void fdir_update_signature_filter(portid_t port_id, uint8_t queue_id,
515 struct rte_fdir_filter *fdir_filter);
516 void fdir_remove_signature_filter(portid_t port_id,
517 struct rte_fdir_filter *fdir_filter);
518 void fdir_get_infos(portid_t port_id);
519 void fdir_add_perfect_filter(portid_t port_id, uint16_t soft_id,
520 uint8_t queue_id, uint8_t drop,
521 struct rte_fdir_filter *fdir_filter);
522 void fdir_update_perfect_filter(portid_t port_id, uint16_t soft_id,
523 uint8_t queue_id, uint8_t drop,
524 struct rte_fdir_filter *fdir_filter);
525 void fdir_remove_perfect_filter(portid_t port_id, uint16_t soft_id,
526 struct rte_fdir_filter *fdir_filter);
527 void fdir_set_masks(portid_t port_id, struct rte_fdir_masks *fdir_masks);
529 void port_rss_reta_info(portid_t port_id, struct rte_eth_rss_reta *reta_conf);
531 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
532 void set_vf_rx_vlan(portid_t port_id, uint16_t vlan_id,
533 uint64_t vf_mask, uint8_t on);
535 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
536 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
539 void port_rss_hash_conf_show(portid_t port_id, int show_rss_key);
540 void port_rss_hash_key_update(portid_t port_id, uint8_t *hash_key);
541 void get_syn_filter(uint8_t port_id);
542 void get_ethertype_filter(uint8_t port_id, uint16_t index);
543 void get_2tuple_filter(uint8_t port_id, uint16_t index);
544 void get_5tuple_filter(uint8_t port_id, uint16_t index);
545 void get_flex_filter(uint8_t port_id, uint16_t index);
548 * Work-around of a compilation error with ICC on invocations of the
549 * rte_be_to_cpu_16() function.
552 #define RTE_BE_TO_CPU_16(be_16_v) rte_be_to_cpu_16((be_16_v))
553 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
555 #ifdef __big_endian__
556 #define RTE_BE_TO_CPU_16(be_16_v) (be_16_v)
557 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
559 #define RTE_BE_TO_CPU_16(be_16_v) \
560 (uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
561 #define RTE_CPU_TO_BE_16(cpu_16_v) \
562 (uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
566 #endif /* _TESTPMD_H_ */