615a7524bec105d65af6e9657a773d2a0ad7653d
[dpdk.git] / app / test-pmd / testpmd.h
1 /*-
2  *   BSD LICENSE
3  * 
4  *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  * 
7  *   Redistribution and use in source and binary forms, with or without 
8  *   modification, are permitted provided that the following conditions 
9  *   are met:
10  * 
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 
16  *       distribution.
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.
20  * 
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.
32  * 
33  */
34
35 #ifndef _TESTPMD_H_
36 #define _TESTPMD_H_
37
38 /* icc on baremetal gives us troubles with function named 'main' */
39 #ifdef RTE_EXEC_ENV_BAREMETAL
40 #define main _main
41 int main(int argc, char **argv);
42 #endif
43
44 #define RTE_PORT_ALL            (~(portid_t)0x0)
45
46 #define RTE_TEST_RX_DESC_MAX    2048
47 #define RTE_TEST_TX_DESC_MAX    2048
48
49 #define RTE_PORT_STOPPED        (uint16_t)0
50 #define RTE_PORT_STARTED        (uint16_t)1
51 #define RTE_PORT_CLOSED         (uint16_t)2
52 #define RTE_PORT_HANDLING       (uint16_t)3
53
54 /*
55  * Default size of the mbuf data buffer to receive standard 1518-byte
56  * Ethernet frames in a mono-segment memory buffer.
57  */
58 #define DEFAULT_MBUF_DATA_SIZE 2048 /**< Default size of mbuf data buffer. */
59
60 /*
61  * The maximum number of segments per packet is used when creating
62  * scattered transmit packets composed of a list of mbufs.
63  */
64 #define RTE_MAX_SEGS_PER_PKT 255 /**< pkt.nb_segs is a 8-bit unsigned char. */
65
66 #define MAX_PKT_BURST 512
67 #define DEF_PKT_BURST 16
68
69 #define CACHE_LINE_SIZE_ROUNDUP(size) \
70         (CACHE_LINE_SIZE * ((size + CACHE_LINE_SIZE - 1) / CACHE_LINE_SIZE))
71
72 #define NUMA_NO_CONFIG 0xFF
73 #define UMA_NO_CONFIG  0xFF
74
75 typedef uint8_t  lcoreid_t;
76 typedef uint8_t  portid_t;
77 typedef uint16_t queueid_t;
78 typedef uint16_t streamid_t;
79
80 #define MAX_QUEUE_ID ((1 << (sizeof(queueid_t) * 8)) - 1)
81
82 enum {
83         PORT_TOPOLOGY_PAIRED,
84         PORT_TOPOLOGY_CHAINED
85 };
86
87 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
88 /**
89  * The data structure associated with RX and TX packet burst statistics
90  * that are recorded for each forwarding stream.
91  */
92 struct pkt_burst_stats {
93         unsigned int pkt_burst_spread[MAX_PKT_BURST];
94 };
95 #endif
96
97 /**
98  * The data structure associated with a forwarding stream between a receive
99  * port/queue and a transmit port/queue.
100  */
101 struct fwd_stream {
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 */
108
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 */
117 #endif
118 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
119         struct pkt_burst_stats rx_burst_stats;
120         struct pkt_burst_stats tx_burst_stats;
121 #endif
122 };
123
124 /**
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
132  */
133 struct rte_port {
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         struct rte_eth_rxconf   rx_conf;    /**< rx configuration */
154         struct rte_eth_txconf   tx_conf;    /**< tx configuration */
155 };
156
157 /**
158  * The data structure associated with each forwarding logical core.
159  * The logical cores are internally numbered by a core index from 0 to
160  * the maximum number of logical cores - 1.
161  * The system CPU identifier of all logical cores are setup in a global
162  * CPU id. configuration table.
163  */
164 struct fwd_lcore {
165         struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
166         streamid_t stream_idx;   /**< index of 1st stream in "fwd_streams" */
167         streamid_t stream_nb;    /**< number of streams in "fwd_streams" */
168         lcoreid_t  cpuid_idx;    /**< index of logical core in CPU id table */
169         queueid_t  tx_queue;     /**< TX queue to send forwarded packets */
170         volatile char stopped;   /**< stop forwarding when set */
171 };
172
173 /*
174  * Forwarding mode operations:
175  *   - IO forwarding mode (default mode)
176  *     Forwards packets unchanged.
177  *
178  *   - MAC forwarding mode
179  *     Set the source and the destination Ethernet addresses of packets
180  *     before forwarding them.
181  *
182  *   - IEEE1588 forwarding mode
183  *     Check that received IEEE1588 Precise Time Protocol (PTP) packets are
184  *     filtered and timestamped by the hardware.
185  *     Forwards packets unchanged on the same port.
186  *     Check that sent IEEE1588 PTP packets are timestamped by the hardware.
187  */
188 typedef void (*port_fwd_begin_t)(portid_t pi);
189 typedef void (*port_fwd_end_t)(portid_t pi);
190 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
191
192 struct fwd_engine {
193         const char       *fwd_mode_name; /**< Forwarding mode name. */
194         port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
195         port_fwd_end_t   port_fwd_end;   /**< NULL if nothing special to do. */
196         packet_fwd_t     packet_fwd;     /**< Mandatory. */
197 };
198
199 extern struct fwd_engine io_fwd_engine;
200 extern struct fwd_engine mac_fwd_engine;
201 extern struct fwd_engine rx_only_engine;
202 extern struct fwd_engine tx_only_engine;
203 extern struct fwd_engine csum_fwd_engine;
204 #ifdef RTE_LIBRTE_IEEE1588
205 extern struct fwd_engine ieee1588_fwd_engine;
206 #endif
207
208 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
209
210 /**
211  * Forwarding Configuration
212  *
213  */
214 struct fwd_config {
215         struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
216         streamid_t nb_fwd_streams;  /**< Nb. of forward streams to process. */
217         lcoreid_t  nb_fwd_lcores;   /**< Nb. of logical cores to launch. */
218         portid_t   nb_fwd_ports;    /**< Nb. of ports involved. */
219 };
220
221 /**
222  * DCB mode enable
223  */
224 enum dcb_mode_enable
225 {
226         DCB_VT_ENABLED,
227         DCB_ENABLED
228 };
229
230 /*
231  * DCB general config info
232  */
233 struct dcb_config {
234         enum dcb_mode_enable dcb_mode;
235         uint8_t vt_en;
236         enum rte_eth_nb_tcs num_tcs;
237         uint8_t pfc_en;
238 };
239  
240 /*
241  * In DCB io FWD mode, 128 RX queue to 128 TX queue mapping
242  */
243 enum dcb_queue_mapping_mode {
244         DCB_VT_Q_MAPPING = 0,
245         DCB_4_TCS_Q_MAPPING,
246         DCB_8_TCS_Q_MAPPING
247 };
248
249 #define MAX_TX_QUEUE_STATS_MAPPINGS 1024 /* MAX_PORT of 32 @ 32 tx_queues/port */
250 #define MAX_RX_QUEUE_STATS_MAPPINGS 4096 /* MAX_PORT of 32 @ 128 rx_queues/port */
251
252 struct queue_stats_mappings {
253         uint8_t port_id;
254         uint16_t queue_id;
255         uint8_t stats_counter_id;
256 } __rte_cache_aligned;
257
258 extern struct queue_stats_mappings tx_queue_stats_mappings_array[];
259 extern struct queue_stats_mappings rx_queue_stats_mappings_array[];
260
261 /* Assign both tx and rx queue stats mappings to the same default values */
262 extern struct queue_stats_mappings *tx_queue_stats_mappings;
263 extern struct queue_stats_mappings *rx_queue_stats_mappings;
264
265 extern uint16_t nb_tx_queue_stats_mappings;
266 extern uint16_t nb_rx_queue_stats_mappings;
267
268 /* globals used for configuration */
269 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
270 extern uint8_t  interactive;
271 extern uint8_t  numa_support; /**< set by "--numa" parameter */
272 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
273
274 #define MAX_SOCKET 2 /*MAX SOCKET:currently, it is 2 */
275
276 /*
277  * Store specified sockets on which memory pool to be used by ports 
278  * is allocated. 
279  */
280 uint8_t port_numa[RTE_MAX_ETHPORTS];
281
282 /*
283  * Store specified sockets on which RX ring to be used by ports
284  * is allocated. 
285  */
286 uint8_t rxring_numa[RTE_MAX_ETHPORTS];
287
288 /*
289  * Store specified sockets on which TX ring to be used by ports
290  * is allocated. 
291  */
292 uint8_t txring_numa[RTE_MAX_ETHPORTS];
293
294 extern uint8_t socket_num;
295
296 /*
297  * Configuration of logical cores:
298  * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
299  */
300 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
301 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
302 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
303 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
304
305 /*
306  * Configuration of Ethernet ports:
307  * nb_fwd_ports <= nb_cfg_ports <= nb_ports
308  */
309 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
310 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
311 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
312 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
313 extern struct rte_port *ports;
314
315 extern struct rte_eth_rxmode rx_mode;
316 extern uint16_t rss_hf;
317
318 extern queueid_t nb_rxq;
319 extern queueid_t nb_txq;
320
321 extern uint16_t nb_rxd;
322 extern uint16_t nb_txd;
323
324 extern uint16_t rx_free_thresh;
325 extern uint8_t rx_drop_en;
326 extern uint16_t tx_free_thresh;
327 extern uint16_t tx_rs_thresh;
328 extern uint32_t txq_flags;
329
330 extern uint8_t dcb_config;
331 extern uint8_t dcb_test;
332 extern enum dcb_queue_mapping_mode dcb_q_mapping;
333
334 extern uint16_t mbuf_data_size; /**< Mbuf data space size. */
335 extern uint32_t param_total_num_mbufs;
336
337 extern struct rte_fdir_conf fdir_conf;
338
339 /*
340  * Configuration of packet segments used by the "txonly" processing engine.
341  */
342 #define TXONLY_DEF_PACKET_LEN 64
343 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
344 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
345 extern uint8_t  tx_pkt_nb_segs; /**< Number of segments in TX packets */
346
347 extern uint16_t nb_pkt_per_burst;
348 extern uint16_t mb_mempool_cache;
349 extern struct rte_eth_thresh rx_thresh;
350 extern struct rte_eth_thresh tx_thresh;
351
352 extern struct fwd_config cur_fwd_config;
353 extern struct fwd_engine *cur_fwd_eng;
354 extern struct fwd_lcore  **fwd_lcores;
355 extern struct fwd_stream **fwd_streams;
356
357 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
358 extern struct ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
359
360 static inline unsigned int
361 lcore_num(void)
362 {
363         unsigned int i;
364
365         for (i = 0; i < RTE_MAX_LCORE; ++i)
366                 if (fwd_lcores_cpuids[i] == rte_lcore_id())
367                         return i;
368
369         rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
370 }
371
372 static inline struct fwd_lcore *
373 current_fwd_lcore(void)
374 {
375         return fwd_lcores[lcore_num()];
376 }
377
378 /* Mbuf Pools */
379 static inline void
380 mbuf_poolname_build(unsigned int sock_id, char* mp_name, int name_size)
381 {
382         rte_snprintf(mp_name, name_size, "mbuf_pool_socket_%u", sock_id);
383 }
384
385 static inline struct rte_mempool *
386 mbuf_pool_find(unsigned int sock_id)
387 {
388         char pool_name[RTE_MEMPOOL_NAMESIZE];
389
390         mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name));
391         return (rte_mempool_lookup((const char *)pool_name));
392 }
393
394 /**
395  * Read/Write operations on a PCI register of a port.
396  */
397 static inline uint32_t
398 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
399 {
400         void *reg_addr;
401         uint32_t reg_v;
402
403         reg_addr = (void *)
404                 ((char *)port->dev_info.pci_dev->mem_resource[0].addr +
405                         reg_off);
406         reg_v = *((volatile uint32_t *)reg_addr);
407         return rte_le_to_cpu_32(reg_v);
408 }
409
410 #define port_id_pci_reg_read(pt_id, reg_off) \
411         port_pci_reg_read(&ports[(pt_id)], (reg_off))
412
413 static inline void
414 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
415 {
416         void *reg_addr;
417
418         reg_addr = (void *)
419                 ((char *)port->dev_info.pci_dev->mem_resource[0].addr +
420                         reg_off);
421         *((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
422 }
423
424 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
425         port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
426
427 /* Prototypes */
428 void launch_args_parse(int argc, char** argv);
429 void prompt(void);
430 void nic_stats_display(portid_t port_id);
431 void nic_stats_clear(portid_t port_id);
432 void nic_stats_mapping_display(portid_t port_id);
433 void port_infos_display(portid_t port_id);
434 void fwd_lcores_config_display(void);
435 void fwd_config_display(void);
436 void rxtx_config_display(void);
437 void fwd_config_setup(void);
438 void set_def_fwd_config(void);
439 int init_fwd_streams(void);
440
441
442 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
443 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
444                       uint8_t bit_v);
445 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
446                                 uint8_t bit1_pos, uint8_t bit2_pos);
447 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
448                             uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
449 void port_reg_display(portid_t port_id, uint32_t reg_off);
450 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
451
452 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
453 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
454
455 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
456 int set_fwd_lcores_mask(uint64_t lcoremask);
457 void set_fwd_lcores_number(uint16_t nb_lc);
458
459 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
460 void set_fwd_ports_mask(uint64_t portmask);
461 void set_fwd_ports_number(uint16_t nb_pt);
462
463 void rx_vlan_strip_set(portid_t port_id, int on);
464 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
465
466 void rx_vlan_filter_set(portid_t port_id, int on);
467 void rx_vlan_all_filter_set(portid_t port_id, int on);
468 void rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
469 void vlan_extend_set(portid_t port_id, int on);
470 void vlan_tpid_set(portid_t port_id, uint16_t tp_id);
471 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
472 void tx_vlan_reset(portid_t port_id);
473
474
475 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
476
477 void tx_cksum_set(portid_t port_id, uint8_t cksum_mask);
478
479 void set_verbose_level(uint16_t vb_level);
480 void set_tx_pkt_segments(unsigned *seg_lengths, unsigned nb_segs);
481 void set_nb_pkt_per_burst(uint16_t pkt_burst);
482 void set_pkt_forwarding_mode(const char *fwd_mode);
483 void start_packet_forwarding(int with_tx_first);
484 void stop_packet_forwarding(void);
485 void init_port_config(void);
486 int init_port_dcb_config(portid_t pid,struct dcb_config *dcb_conf);
487 void start_port(portid_t pid);
488 void stop_port(portid_t pid);
489 void close_port(portid_t pid);
490 int all_ports_stopped(void);
491 void pmd_test_exit(void);
492
493 void fdir_add_signature_filter(portid_t port_id, uint8_t queue_id,
494                                struct rte_fdir_filter *fdir_filter);
495 void fdir_update_signature_filter(portid_t port_id, uint8_t queue_id,
496                                   struct rte_fdir_filter *fdir_filter);
497 void fdir_remove_signature_filter(portid_t port_id,
498                                   struct rte_fdir_filter *fdir_filter);
499 void fdir_get_infos(portid_t port_id);
500 void fdir_add_perfect_filter(portid_t port_id, uint16_t soft_id,
501                              uint8_t queue_id, uint8_t drop,
502                              struct rte_fdir_filter *fdir_filter);
503 void fdir_update_perfect_filter(portid_t port_id, uint16_t soft_id,
504                                 uint8_t queue_id, uint8_t drop,
505                                 struct rte_fdir_filter *fdir_filter);
506 void fdir_remove_perfect_filter(portid_t port_id, uint16_t soft_id,
507                                 struct rte_fdir_filter *fdir_filter);
508 void fdir_set_masks(portid_t port_id, struct rte_fdir_masks *fdir_masks);
509 void port_rss_reta_info(portid_t port_id, struct rte_eth_rss_reta *reta_conf);
510
511 /*
512  * Work-around of a compilation error with ICC on invocations of the
513  * rte_be_to_cpu_16() function.
514  */
515 #ifdef __GCC__
516 #define RTE_BE_TO_CPU_16(be_16_v)  rte_be_to_cpu_16((be_16_v))
517 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
518 #else
519 #ifdef __big_endian__
520 #define RTE_BE_TO_CPU_16(be_16_v)  (be_16_v)
521 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
522 #else
523 #define RTE_BE_TO_CPU_16(be_16_v) \
524         (uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
525 #define RTE_CPU_TO_BE_16(cpu_16_v) \
526         (uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
527 #endif
528 #endif /* __GCC__ */
529
530 #endif /* _TESTPMD_H_ */