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 /**< nb_segs is a 8-bit unsigned char. */
65 #define MAX_PKT_BURST 512
66 #define DEF_PKT_BURST 32
68 #define DEF_MBUF_CACHE 250
70 #define CACHE_LINE_SIZE_ROUNDUP(size) \
71 (CACHE_LINE_SIZE * ((size + CACHE_LINE_SIZE - 1) / CACHE_LINE_SIZE))
73 #define NUMA_NO_CONFIG 0xFF
74 #define UMA_NO_CONFIG 0xFF
76 typedef uint8_t lcoreid_t;
77 typedef uint8_t portid_t;
78 typedef uint16_t queueid_t;
79 typedef uint16_t streamid_t;
81 #define MAX_QUEUE_ID ((1 << (sizeof(queueid_t) * 8)) - 1)
85 PORT_TOPOLOGY_CHAINED,
89 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
91 * The data structure associated with RX and TX packet burst statistics
92 * that are recorded for each forwarding stream.
94 struct pkt_burst_stats {
95 unsigned int pkt_burst_spread[MAX_PKT_BURST];
100 * The data structure associated with a forwarding stream between a receive
101 * port/queue and a transmit port/queue.
104 /* "read-only" data */
105 portid_t rx_port; /**< port to poll for received packets */
106 queueid_t rx_queue; /**< RX queue to poll on "rx_port" */
107 portid_t tx_port; /**< forwarding port of received packets */
108 queueid_t tx_queue; /**< TX queue to send forwarded packets */
109 streamid_t peer_addr; /**< index of peer ethernet address of packets */
111 /* "read-write" results */
112 unsigned int rx_packets; /**< received packets */
113 unsigned int tx_packets; /**< received packets transmitted */
114 unsigned int fwd_dropped; /**< received packets not forwarded */
115 unsigned int rx_bad_ip_csum ; /**< received packets has bad ip checksum */
116 unsigned int rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
117 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
118 uint64_t core_cycles; /**< used for RX and TX processing */
120 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
121 struct pkt_burst_stats rx_burst_stats;
122 struct pkt_burst_stats tx_burst_stats;
127 * The data structure associated with each port.
128 * tx_ol_flags is slightly different from ol_flags of rte_mbuf.
129 * Bit 0: Insert IP checksum
130 * Bit 1: Insert UDP checksum
131 * Bit 2: Insert TCP checksum
132 * Bit 3: Insert SCTP checksum
133 * Bit 11: Insert VLAN Label
136 struct rte_eth_dev_info dev_info; /**< PCI info + driver name */
137 struct rte_eth_conf dev_conf; /**< Port configuration. */
138 struct ether_addr eth_addr; /**< Port ethernet address */
139 struct rte_eth_stats stats; /**< Last port statistics */
140 uint64_t tx_dropped; /**< If no descriptor in TX ring */
141 struct fwd_stream *rx_stream; /**< Port RX stream, if unique */
142 struct fwd_stream *tx_stream; /**< Port TX stream, if unique */
143 unsigned int socket_id; /**< For NUMA support */
144 uint16_t tx_ol_flags;/**< Offload Flags of TX packets. */
145 uint16_t tx_vlan_id; /**< Tag Id. in TX VLAN packets. */
146 void *fwd_ctx; /**< Forwarding mode context */
147 uint64_t rx_bad_ip_csum; /**< rx pkts with bad ip checksum */
148 uint64_t rx_bad_l4_csum; /**< rx pkts with bad l4 checksum */
149 uint8_t tx_queue_stats_mapping_enabled;
150 uint8_t rx_queue_stats_mapping_enabled;
151 volatile uint16_t port_status; /**< port started or not */
152 uint8_t need_reconfig; /**< need reconfiguring port or not */
153 uint8_t need_reconfig_queues; /**< need reconfiguring queues or not */
154 uint8_t rss_flag; /**< enable rss or not */
155 uint8_t dcb_flag; /**< enable dcb */
156 struct rte_eth_rxconf rx_conf; /**< rx configuration */
157 struct rte_eth_txconf tx_conf; /**< tx configuration */
161 * The data structure associated with each forwarding logical core.
162 * The logical cores are internally numbered by a core index from 0 to
163 * the maximum number of logical cores - 1.
164 * The system CPU identifier of all logical cores are setup in a global
165 * CPU id. configuration table.
168 struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
169 streamid_t stream_idx; /**< index of 1st stream in "fwd_streams" */
170 streamid_t stream_nb; /**< number of streams in "fwd_streams" */
171 lcoreid_t cpuid_idx; /**< index of logical core in CPU id table */
172 queueid_t tx_queue; /**< TX queue to send forwarded packets */
173 volatile char stopped; /**< stop forwarding when set */
177 * Forwarding mode operations:
178 * - IO forwarding mode (default mode)
179 * Forwards packets unchanged.
181 * - MAC forwarding mode
182 * Set the source and the destination Ethernet addresses of packets
183 * before forwarding them.
185 * - IEEE1588 forwarding mode
186 * Check that received IEEE1588 Precise Time Protocol (PTP) packets are
187 * filtered and timestamped by the hardware.
188 * Forwards packets unchanged on the same port.
189 * Check that sent IEEE1588 PTP packets are timestamped by the hardware.
191 typedef void (*port_fwd_begin_t)(portid_t pi);
192 typedef void (*port_fwd_end_t)(portid_t pi);
193 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
196 const char *fwd_mode_name; /**< Forwarding mode name. */
197 port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
198 port_fwd_end_t port_fwd_end; /**< NULL if nothing special to do. */
199 packet_fwd_t packet_fwd; /**< Mandatory. */
202 extern struct fwd_engine io_fwd_engine;
203 extern struct fwd_engine mac_fwd_engine;
204 extern struct fwd_engine mac_retry_fwd_engine;
205 extern struct fwd_engine mac_swap_engine;
206 extern struct fwd_engine flow_gen_engine;
207 extern struct fwd_engine rx_only_engine;
208 extern struct fwd_engine tx_only_engine;
209 extern struct fwd_engine csum_fwd_engine;
210 extern struct fwd_engine icmp_echo_engine;
211 #ifdef RTE_LIBRTE_IEEE1588
212 extern struct fwd_engine ieee1588_fwd_engine;
215 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
218 * Forwarding Configuration
222 struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
223 streamid_t nb_fwd_streams; /**< Nb. of forward streams to process. */
224 lcoreid_t nb_fwd_lcores; /**< Nb. of logical cores to launch. */
225 portid_t nb_fwd_ports; /**< Nb. of ports involved. */
238 * DCB general config info
241 enum dcb_mode_enable dcb_mode;
243 enum rte_eth_nb_tcs num_tcs;
248 * In DCB io FWD mode, 128 RX queue to 128 TX queue mapping
250 enum dcb_queue_mapping_mode {
251 DCB_VT_Q_MAPPING = 0,
256 #define MAX_TX_QUEUE_STATS_MAPPINGS 1024 /* MAX_PORT of 32 @ 32 tx_queues/port */
257 #define MAX_RX_QUEUE_STATS_MAPPINGS 4096 /* MAX_PORT of 32 @ 128 rx_queues/port */
259 struct queue_stats_mappings {
262 uint8_t stats_counter_id;
263 } __rte_cache_aligned;
265 extern struct queue_stats_mappings tx_queue_stats_mappings_array[];
266 extern struct queue_stats_mappings rx_queue_stats_mappings_array[];
268 /* Assign both tx and rx queue stats mappings to the same default values */
269 extern struct queue_stats_mappings *tx_queue_stats_mappings;
270 extern struct queue_stats_mappings *rx_queue_stats_mappings;
272 extern uint16_t nb_tx_queue_stats_mappings;
273 extern uint16_t nb_rx_queue_stats_mappings;
275 /* globals used for configuration */
276 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
277 extern uint8_t interactive;
278 extern uint8_t auto_start;
279 extern uint8_t numa_support; /**< set by "--numa" parameter */
280 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
281 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
282 extern uint8_t mp_anon; /**< set by "--mp-anon" parameter */
283 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
284 extern volatile int test_done; /* stop packet forwarding when set to 1. */
286 #ifdef RTE_NIC_BYPASS
287 extern uint32_t bypass_timeout; /**< Store the NIC bypass watchdog timeout */
290 #define MAX_SOCKET 2 /*MAX SOCKET:currently, it is 2 */
293 * Store specified sockets on which memory pool to be used by ports
296 uint8_t port_numa[RTE_MAX_ETHPORTS];
299 * Store specified sockets on which RX ring to be used by ports
302 uint8_t rxring_numa[RTE_MAX_ETHPORTS];
305 * Store specified sockets on which TX ring to be used by ports
308 uint8_t txring_numa[RTE_MAX_ETHPORTS];
310 extern uint8_t socket_num;
313 * Configuration of logical cores:
314 * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
316 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
317 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
318 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
319 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
322 * Configuration of Ethernet ports:
323 * nb_fwd_ports <= nb_cfg_ports <= nb_ports
325 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
326 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
327 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
328 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
329 extern struct rte_port *ports;
331 extern struct rte_eth_rxmode rx_mode;
332 extern uint64_t rss_hf;
334 extern queueid_t nb_rxq;
335 extern queueid_t nb_txq;
337 extern uint16_t nb_rxd;
338 extern uint16_t nb_txd;
340 extern uint16_t rx_free_thresh;
341 extern uint8_t rx_drop_en;
342 extern uint16_t tx_free_thresh;
343 extern uint16_t tx_rs_thresh;
344 extern uint32_t txq_flags;
346 extern uint8_t dcb_config;
347 extern uint8_t dcb_test;
348 extern enum dcb_queue_mapping_mode dcb_q_mapping;
350 extern uint16_t mbuf_data_size; /**< Mbuf data space size. */
351 extern uint32_t param_total_num_mbufs;
353 extern struct rte_fdir_conf fdir_conf;
356 * Configuration of packet segments used by the "txonly" processing engine.
358 #define TXONLY_DEF_PACKET_LEN 64
359 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
360 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
361 extern uint8_t tx_pkt_nb_segs; /**< Number of segments in TX packets */
363 extern uint16_t nb_pkt_per_burst;
364 extern uint16_t mb_mempool_cache;
365 extern struct rte_eth_thresh rx_thresh;
366 extern struct rte_eth_thresh tx_thresh;
368 extern struct fwd_config cur_fwd_config;
369 extern struct fwd_engine *cur_fwd_eng;
370 extern struct fwd_lcore **fwd_lcores;
371 extern struct fwd_stream **fwd_streams;
373 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
374 extern struct ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
376 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
377 extern uint32_t burst_tx_retry_num; /**< Burst tx retry number for mac-retry. */
379 static inline unsigned int
384 for (i = 0; i < RTE_MAX_LCORE; ++i)
385 if (fwd_lcores_cpuids[i] == rte_lcore_id())
388 rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
391 static inline struct fwd_lcore *
392 current_fwd_lcore(void)
394 return fwd_lcores[lcore_num()];
399 mbuf_poolname_build(unsigned int sock_id, char* mp_name, int name_size)
401 snprintf(mp_name, name_size, "mbuf_pool_socket_%u", sock_id);
404 static inline struct rte_mempool *
405 mbuf_pool_find(unsigned int sock_id)
407 char pool_name[RTE_MEMPOOL_NAMESIZE];
409 mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name));
410 return (rte_mempool_lookup((const char *)pool_name));
414 * Read/Write operations on a PCI register of a port.
416 static inline uint32_t
417 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
423 ((char *)port->dev_info.pci_dev->mem_resource[0].addr +
425 reg_v = *((volatile uint32_t *)reg_addr);
426 return rte_le_to_cpu_32(reg_v);
429 #define port_id_pci_reg_read(pt_id, reg_off) \
430 port_pci_reg_read(&ports[(pt_id)], (reg_off))
433 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
438 ((char *)port->dev_info.pci_dev->mem_resource[0].addr +
440 *((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
443 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
444 port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
447 void launch_args_parse(int argc, char** argv);
449 void nic_stats_display(portid_t port_id);
450 void nic_stats_clear(portid_t port_id);
451 void nic_stats_mapping_display(portid_t port_id);
452 void port_infos_display(portid_t port_id);
453 void fwd_lcores_config_display(void);
454 void fwd_config_display(void);
455 void rxtx_config_display(void);
456 void fwd_config_setup(void);
457 void set_def_fwd_config(void);
458 void reconfig(portid_t new_port_id);
459 int init_fwd_streams(void);
461 void port_mtu_set(portid_t port_id, uint16_t mtu);
462 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
463 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
465 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
466 uint8_t bit1_pos, uint8_t bit2_pos);
467 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
468 uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
469 void port_reg_display(portid_t port_id, uint32_t reg_off);
470 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
472 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
473 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
475 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
476 int set_fwd_lcores_mask(uint64_t lcoremask);
477 void set_fwd_lcores_number(uint16_t nb_lc);
479 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
480 void set_fwd_ports_mask(uint64_t portmask);
481 void set_fwd_ports_number(uint16_t nb_pt);
483 void rx_vlan_strip_set(portid_t port_id, int on);
484 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
486 void rx_vlan_filter_set(portid_t port_id, int on);
487 void rx_vlan_all_filter_set(portid_t port_id, int on);
488 void rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
489 void vlan_extend_set(portid_t port_id, int on);
490 void vlan_tpid_set(portid_t port_id, uint16_t tp_id);
491 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
492 void tx_vlan_reset(portid_t port_id);
493 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
495 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
497 void tx_cksum_set(portid_t port_id, uint8_t cksum_mask);
499 void set_verbose_level(uint16_t vb_level);
500 void set_tx_pkt_segments(unsigned *seg_lengths, unsigned nb_segs);
501 void set_nb_pkt_per_burst(uint16_t pkt_burst);
502 char *list_pkt_forwarding_modes(void);
503 void set_pkt_forwarding_mode(const char *fwd_mode);
504 void start_packet_forwarding(int with_tx_first);
505 void stop_packet_forwarding(void);
506 void dev_set_link_up(portid_t pid);
507 void dev_set_link_down(portid_t pid);
508 void init_port_config(void);
509 int init_port_dcb_config(portid_t pid,struct dcb_config *dcb_conf);
510 int start_port(portid_t pid);
511 void stop_port(portid_t pid);
512 void close_port(portid_t pid);
513 int all_ports_stopped(void);
514 int port_is_started(portid_t port_id);
515 void pmd_test_exit(void);
517 void fdir_add_signature_filter(portid_t port_id, uint8_t queue_id,
518 struct rte_fdir_filter *fdir_filter);
519 void fdir_update_signature_filter(portid_t port_id, uint8_t queue_id,
520 struct rte_fdir_filter *fdir_filter);
521 void fdir_remove_signature_filter(portid_t port_id,
522 struct rte_fdir_filter *fdir_filter);
523 void fdir_get_infos(portid_t port_id);
524 void fdir_add_perfect_filter(portid_t port_id, uint16_t soft_id,
525 uint8_t queue_id, uint8_t drop,
526 struct rte_fdir_filter *fdir_filter);
527 void fdir_update_perfect_filter(portid_t port_id, uint16_t soft_id,
528 uint8_t queue_id, uint8_t drop,
529 struct rte_fdir_filter *fdir_filter);
530 void fdir_remove_perfect_filter(portid_t port_id, uint16_t soft_id,
531 struct rte_fdir_filter *fdir_filter);
532 void fdir_set_masks(portid_t port_id, struct rte_fdir_masks *fdir_masks);
534 void port_rss_reta_info(portid_t port_id, struct rte_eth_rss_reta *reta_conf);
536 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
537 void set_vf_rx_vlan(portid_t port_id, uint16_t vlan_id,
538 uint64_t vf_mask, uint8_t on);
540 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
541 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
544 void port_rss_hash_conf_show(portid_t port_id, int show_rss_key);
545 void port_rss_hash_key_update(portid_t port_id, uint8_t *hash_key);
546 void get_syn_filter(uint8_t port_id);
547 void get_ethertype_filter(uint8_t port_id, uint16_t index);
548 void get_2tuple_filter(uint8_t port_id, uint16_t index);
549 void get_5tuple_filter(uint8_t port_id, uint16_t index);
550 void get_flex_filter(uint8_t port_id, uint16_t index);
551 int port_id_is_invalid(portid_t port_id);
552 int rx_queue_id_is_invalid(queueid_t rxq_id);
553 int tx_queue_id_is_invalid(queueid_t txq_id);
556 * Work-around of a compilation error with ICC on invocations of the
557 * rte_be_to_cpu_16() function.
560 #define RTE_BE_TO_CPU_16(be_16_v) rte_be_to_cpu_16((be_16_v))
561 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
563 #ifdef __big_endian__
564 #define RTE_BE_TO_CPU_16(be_16_v) (be_16_v)
565 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
567 #define RTE_BE_TO_CPU_16(be_16_v) \
568 (uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
569 #define RTE_CPU_TO_BE_16(cpu_16_v) \
570 (uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
574 #endif /* _TESTPMD_H_ */