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