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 #define RTE_PORT_ALL (~(portid_t)0x0)
39 #define RTE_TEST_RX_DESC_MAX 2048
40 #define RTE_TEST_TX_DESC_MAX 2048
42 #define RTE_PORT_STOPPED (uint16_t)0
43 #define RTE_PORT_STARTED (uint16_t)1
44 #define RTE_PORT_CLOSED (uint16_t)2
45 #define RTE_PORT_HANDLING (uint16_t)3
48 * Default size of the mbuf data buffer to receive standard 1518-byte
49 * Ethernet frames in a mono-segment memory buffer.
51 #define DEFAULT_MBUF_DATA_SIZE 2048 /**< Default size of mbuf data buffer. */
54 * The maximum number of segments per packet is used when creating
55 * scattered transmit packets composed of a list of mbufs.
57 #define RTE_MAX_SEGS_PER_PKT 255 /**< nb_segs is a 8-bit unsigned char. */
59 #define MAX_PKT_BURST 512
60 #define DEF_PKT_BURST 32
62 #define DEF_MBUF_CACHE 250
64 #define RTE_CACHE_LINE_SIZE_ROUNDUP(size) \
65 (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
67 #define NUMA_NO_CONFIG 0xFF
68 #define UMA_NO_CONFIG 0xFF
70 typedef uint8_t lcoreid_t;
71 typedef uint8_t portid_t;
72 typedef uint16_t queueid_t;
73 typedef uint16_t streamid_t;
75 #define MAX_QUEUE_ID ((1 << (sizeof(queueid_t) * 8)) - 1)
79 PORT_TOPOLOGY_CHAINED,
83 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
85 * The data structure associated with RX and TX packet burst statistics
86 * that are recorded for each forwarding stream.
88 struct pkt_burst_stats {
89 unsigned int pkt_burst_spread[MAX_PKT_BURST];
94 * The data structure associated with a forwarding stream between a receive
95 * port/queue and a transmit port/queue.
98 /* "read-only" data */
99 portid_t rx_port; /**< port to poll for received packets */
100 queueid_t rx_queue; /**< RX queue to poll on "rx_port" */
101 portid_t tx_port; /**< forwarding port of received packets */
102 queueid_t tx_queue; /**< TX queue to send forwarded packets */
103 streamid_t peer_addr; /**< index of peer ethernet address of packets */
105 /* "read-write" results */
106 unsigned int rx_packets; /**< received packets */
107 unsigned int tx_packets; /**< received packets transmitted */
108 unsigned int fwd_dropped; /**< received packets not forwarded */
109 unsigned int rx_bad_ip_csum ; /**< received packets has bad ip checksum */
110 unsigned int rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
111 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
112 uint64_t core_cycles; /**< used for RX and TX processing */
114 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
115 struct pkt_burst_stats rx_burst_stats;
116 struct pkt_burst_stats tx_burst_stats;
120 /** Offload IP checksum in csum forward engine */
121 #define TESTPMD_TX_OFFLOAD_IP_CKSUM 0x0001
122 /** Offload UDP checksum in csum forward engine */
123 #define TESTPMD_TX_OFFLOAD_UDP_CKSUM 0x0002
124 /** Offload TCP checksum in csum forward engine */
125 #define TESTPMD_TX_OFFLOAD_TCP_CKSUM 0x0004
126 /** Offload SCTP checksum in csum forward engine */
127 #define TESTPMD_TX_OFFLOAD_SCTP_CKSUM 0x0008
128 /** Offload outer IP checksum in csum forward engine for recognized tunnels */
129 #define TESTPMD_TX_OFFLOAD_OUTER_IP_CKSUM 0x0010
130 /** Parse tunnel in csum forward engine. If set, dissect tunnel headers
131 * of rx packets. If not set, treat inner headers as payload. */
132 #define TESTPMD_TX_OFFLOAD_PARSE_TUNNEL 0x0020
133 /** Insert VLAN header in forward engine */
134 #define TESTPMD_TX_OFFLOAD_INSERT_VLAN 0x0040
137 * The data structure associated with each port.
140 struct rte_eth_dev_info dev_info; /**< PCI info + driver name */
141 struct rte_eth_conf dev_conf; /**< Port configuration. */
142 struct ether_addr eth_addr; /**< Port ethernet address */
143 struct rte_eth_stats stats; /**< Last port statistics */
144 uint64_t tx_dropped; /**< If no descriptor in TX ring */
145 struct fwd_stream *rx_stream; /**< Port RX stream, if unique */
146 struct fwd_stream *tx_stream; /**< Port TX stream, if unique */
147 unsigned int socket_id; /**< For NUMA support */
148 uint16_t tx_ol_flags;/**< TX Offload Flags (TESTPMD_TX_OFFLOAD...). */
149 uint16_t tso_segsz; /**< MSS for segmentation offload. */
150 uint16_t tx_vlan_id; /**< Tag Id. in TX VLAN packets. */
151 void *fwd_ctx; /**< Forwarding mode context */
152 uint64_t rx_bad_ip_csum; /**< rx pkts with bad ip checksum */
153 uint64_t rx_bad_l4_csum; /**< rx pkts with bad l4 checksum */
154 uint8_t tx_queue_stats_mapping_enabled;
155 uint8_t rx_queue_stats_mapping_enabled;
156 volatile uint16_t port_status; /**< port started or not */
157 uint8_t need_reconfig; /**< need reconfiguring port or not */
158 uint8_t need_reconfig_queues; /**< need reconfiguring queues or not */
159 uint8_t rss_flag; /**< enable rss or not */
160 uint8_t dcb_flag; /**< enable dcb */
161 struct rte_eth_rxconf rx_conf; /**< rx configuration */
162 struct rte_eth_txconf tx_conf; /**< tx configuration */
166 * The data structure associated with each forwarding logical core.
167 * The logical cores are internally numbered by a core index from 0 to
168 * the maximum number of logical cores - 1.
169 * The system CPU identifier of all logical cores are setup in a global
170 * CPU id. configuration table.
173 struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
174 streamid_t stream_idx; /**< index of 1st stream in "fwd_streams" */
175 streamid_t stream_nb; /**< number of streams in "fwd_streams" */
176 lcoreid_t cpuid_idx; /**< index of logical core in CPU id table */
177 queueid_t tx_queue; /**< TX queue to send forwarded packets */
178 volatile char stopped; /**< stop forwarding when set */
182 * Forwarding mode operations:
183 * - IO forwarding mode (default mode)
184 * Forwards packets unchanged.
186 * - MAC forwarding mode
187 * Set the source and the destination Ethernet addresses of packets
188 * before forwarding them.
190 * - IEEE1588 forwarding mode
191 * Check that received IEEE1588 Precise Time Protocol (PTP) packets are
192 * filtered and timestamped by the hardware.
193 * Forwards packets unchanged on the same port.
194 * Check that sent IEEE1588 PTP packets are timestamped by the hardware.
196 typedef void (*port_fwd_begin_t)(portid_t pi);
197 typedef void (*port_fwd_end_t)(portid_t pi);
198 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
201 const char *fwd_mode_name; /**< Forwarding mode name. */
202 port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
203 port_fwd_end_t port_fwd_end; /**< NULL if nothing special to do. */
204 packet_fwd_t packet_fwd; /**< Mandatory. */
207 extern struct fwd_engine io_fwd_engine;
208 extern struct fwd_engine mac_fwd_engine;
209 extern struct fwd_engine mac_retry_fwd_engine;
210 extern struct fwd_engine mac_swap_engine;
211 extern struct fwd_engine flow_gen_engine;
212 extern struct fwd_engine rx_only_engine;
213 extern struct fwd_engine tx_only_engine;
214 extern struct fwd_engine csum_fwd_engine;
215 extern struct fwd_engine icmp_echo_engine;
216 #ifdef RTE_LIBRTE_IEEE1588
217 extern struct fwd_engine ieee1588_fwd_engine;
220 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
223 * Forwarding Configuration
227 struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
228 streamid_t nb_fwd_streams; /**< Nb. of forward streams to process. */
229 lcoreid_t nb_fwd_lcores; /**< Nb. of logical cores to launch. */
230 portid_t nb_fwd_ports; /**< Nb. of ports involved. */
243 * DCB general config info
246 enum dcb_mode_enable dcb_mode;
248 enum rte_eth_nb_tcs num_tcs;
253 * In DCB io FWD mode, 128 RX queue to 128 TX queue mapping
255 enum dcb_queue_mapping_mode {
256 DCB_VT_Q_MAPPING = 0,
261 #define MAX_TX_QUEUE_STATS_MAPPINGS 1024 /* MAX_PORT of 32 @ 32 tx_queues/port */
262 #define MAX_RX_QUEUE_STATS_MAPPINGS 4096 /* MAX_PORT of 32 @ 128 rx_queues/port */
264 struct queue_stats_mappings {
267 uint8_t stats_counter_id;
268 } __rte_cache_aligned;
270 extern struct queue_stats_mappings tx_queue_stats_mappings_array[];
271 extern struct queue_stats_mappings rx_queue_stats_mappings_array[];
273 /* Assign both tx and rx queue stats mappings to the same default values */
274 extern struct queue_stats_mappings *tx_queue_stats_mappings;
275 extern struct queue_stats_mappings *rx_queue_stats_mappings;
277 extern uint16_t nb_tx_queue_stats_mappings;
278 extern uint16_t nb_rx_queue_stats_mappings;
280 /* globals used for configuration */
281 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
282 extern uint8_t interactive;
283 extern uint8_t auto_start;
284 extern uint8_t numa_support; /**< set by "--numa" parameter */
285 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
286 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
287 extern uint8_t mp_anon; /**< set by "--mp-anon" parameter */
288 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
289 extern volatile int test_done; /* stop packet forwarding when set to 1. */
291 #ifdef RTE_NIC_BYPASS
292 extern uint32_t bypass_timeout; /**< Store the NIC bypass watchdog timeout */
295 #define MAX_SOCKET 2 /*MAX SOCKET:currently, it is 2 */
298 * Store specified sockets on which memory pool to be used by ports
301 uint8_t port_numa[RTE_MAX_ETHPORTS];
304 * Store specified sockets on which RX ring to be used by ports
307 uint8_t rxring_numa[RTE_MAX_ETHPORTS];
310 * Store specified sockets on which TX ring to be used by ports
313 uint8_t txring_numa[RTE_MAX_ETHPORTS];
315 extern uint8_t socket_num;
318 * Configuration of logical cores:
319 * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
321 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
322 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
323 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
324 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
327 * Configuration of Ethernet ports:
328 * nb_fwd_ports <= nb_cfg_ports <= nb_ports
330 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
331 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
332 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
333 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
334 extern struct rte_port *ports;
336 extern struct rte_eth_rxmode rx_mode;
337 extern uint64_t rss_hf;
339 extern queueid_t nb_rxq;
340 extern queueid_t nb_txq;
342 extern uint16_t nb_rxd;
343 extern uint16_t nb_txd;
345 extern int16_t rx_free_thresh;
346 extern int8_t rx_drop_en;
347 extern int16_t tx_free_thresh;
348 extern int16_t tx_rs_thresh;
349 extern int32_t txq_flags;
351 extern uint8_t dcb_config;
352 extern uint8_t dcb_test;
353 extern enum dcb_queue_mapping_mode dcb_q_mapping;
355 extern uint16_t mbuf_data_size; /**< Mbuf data space size. */
356 extern uint32_t param_total_num_mbufs;
358 extern struct rte_fdir_conf fdir_conf;
361 * Configuration of packet segments used by the "txonly" processing engine.
363 #define TXONLY_DEF_PACKET_LEN 64
364 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
365 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
366 extern uint8_t tx_pkt_nb_segs; /**< Number of segments in TX packets */
368 extern uint16_t nb_pkt_per_burst;
369 extern uint16_t mb_mempool_cache;
370 extern int8_t rx_pthresh;
371 extern int8_t rx_hthresh;
372 extern int8_t rx_wthresh;
373 extern int8_t tx_pthresh;
374 extern int8_t tx_hthresh;
375 extern int8_t tx_wthresh;
377 extern struct fwd_config cur_fwd_config;
378 extern struct fwd_engine *cur_fwd_eng;
379 extern struct fwd_lcore **fwd_lcores;
380 extern struct fwd_stream **fwd_streams;
382 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
383 extern struct ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
385 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
386 extern uint32_t burst_tx_retry_num; /**< Burst tx retry number for mac-retry. */
388 static inline unsigned int
393 for (i = 0; i < RTE_MAX_LCORE; ++i)
394 if (fwd_lcores_cpuids[i] == rte_lcore_id())
397 rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
400 static inline struct fwd_lcore *
401 current_fwd_lcore(void)
403 return fwd_lcores[lcore_num()];
408 mbuf_poolname_build(unsigned int sock_id, char* mp_name, int name_size)
410 snprintf(mp_name, name_size, "mbuf_pool_socket_%u", sock_id);
413 static inline struct rte_mempool *
414 mbuf_pool_find(unsigned int sock_id)
416 char pool_name[RTE_MEMPOOL_NAMESIZE];
418 mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name));
419 return (rte_mempool_lookup((const char *)pool_name));
423 * Read/Write operations on a PCI register of a port.
425 static inline uint32_t
426 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
432 ((char *)port->dev_info.pci_dev->mem_resource[0].addr +
434 reg_v = *((volatile uint32_t *)reg_addr);
435 return rte_le_to_cpu_32(reg_v);
438 #define port_id_pci_reg_read(pt_id, reg_off) \
439 port_pci_reg_read(&ports[(pt_id)], (reg_off))
442 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
447 ((char *)port->dev_info.pci_dev->mem_resource[0].addr +
449 *((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
452 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
453 port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
456 unsigned int parse_item_list(char* str, const char* item_name,
457 unsigned int max_items,
458 unsigned int *parsed_items, int check_unique_values);
459 void launch_args_parse(int argc, char** argv);
461 void nic_stats_display(portid_t port_id);
462 void nic_stats_clear(portid_t port_id);
463 void nic_xstats_display(portid_t port_id);
464 void nic_xstats_clear(portid_t port_id);
465 void nic_stats_mapping_display(portid_t port_id);
466 void port_infos_display(portid_t port_id);
467 void fwd_lcores_config_display(void);
468 void fwd_config_display(void);
469 void rxtx_config_display(void);
470 void fwd_config_setup(void);
471 void set_def_fwd_config(void);
472 void reconfig(portid_t new_port_id, unsigned socket_id);
473 int init_fwd_streams(void);
475 void port_mtu_set(portid_t port_id, uint16_t mtu);
476 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
477 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
479 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
480 uint8_t bit1_pos, uint8_t bit2_pos);
481 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
482 uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
483 void port_reg_display(portid_t port_id, uint32_t reg_off);
484 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
486 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
487 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
489 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
490 int set_fwd_lcores_mask(uint64_t lcoremask);
491 void set_fwd_lcores_number(uint16_t nb_lc);
493 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
494 void set_fwd_ports_mask(uint64_t portmask);
495 void set_fwd_ports_number(uint16_t nb_pt);
497 void rx_vlan_strip_set(portid_t port_id, int on);
498 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
500 void rx_vlan_filter_set(portid_t port_id, int on);
501 void rx_vlan_all_filter_set(portid_t port_id, int on);
502 void rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
503 void vlan_extend_set(portid_t port_id, int on);
504 void vlan_tpid_set(portid_t port_id, uint16_t tp_id);
505 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
506 void tx_vlan_reset(portid_t port_id);
507 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
509 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
511 void set_verbose_level(uint16_t vb_level);
512 void set_tx_pkt_segments(unsigned *seg_lengths, unsigned nb_segs);
513 void set_nb_pkt_per_burst(uint16_t pkt_burst);
514 char *list_pkt_forwarding_modes(void);
515 void set_pkt_forwarding_mode(const char *fwd_mode);
516 void start_packet_forwarding(int with_tx_first);
517 void stop_packet_forwarding(void);
518 void dev_set_link_up(portid_t pid);
519 void dev_set_link_down(portid_t pid);
520 void init_port_config(void);
521 int init_port_dcb_config(portid_t pid,struct dcb_config *dcb_conf);
522 int start_port(portid_t pid);
523 void stop_port(portid_t pid);
524 void close_port(portid_t pid);
525 int all_ports_stopped(void);
526 int port_is_started(portid_t port_id);
527 void pmd_test_exit(void);
528 void fdir_get_infos(portid_t port_id);
529 void fdir_set_flex_mask(portid_t port_id,
530 struct rte_eth_fdir_flex_mask *cfg);
531 void fdir_set_flex_payload(portid_t port_id,
532 struct rte_eth_flex_payload_cfg *cfg);
533 void port_rss_reta_info(portid_t port_id,
534 struct rte_eth_rss_reta_entry64 *reta_conf,
535 uint16_t nb_entries);
537 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
538 void set_vf_rx_vlan(portid_t port_id, uint16_t vlan_id,
539 uint64_t vf_mask, uint8_t on);
541 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
542 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
545 void port_rss_hash_conf_show(portid_t port_id, int show_rss_key);
546 void port_rss_hash_key_update(portid_t port_id, uint8_t *hash_key);
547 void get_syn_filter(uint8_t port_id);
548 void get_ethertype_filter(uint8_t port_id, uint16_t index);
549 void get_2tuple_filter(uint8_t port_id, uint16_t index);
550 void get_5tuple_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 #if RTE_BYTE_ORDER == RTE_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_ */