app/testpmd: add extended Rx queue setup
[dpdk.git] / app / test-pmd / testpmd.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2017 Intel Corporation
3  */
4
5 #ifndef _TESTPMD_H_
6 #define _TESTPMD_H_
7
8 #include <stdbool.h>
9
10 #include <rte_pci.h>
11 #include <rte_bus_pci.h>
12 #include <rte_gro.h>
13 #include <rte_gso.h>
14 #include <cmdline.h>
15 #include <sys/queue.h>
16
17 #define RTE_PORT_ALL            (~(portid_t)0x0)
18
19 #define RTE_TEST_RX_DESC_MAX    2048
20 #define RTE_TEST_TX_DESC_MAX    2048
21
22 #define RTE_PORT_STOPPED        (uint16_t)0
23 #define RTE_PORT_STARTED        (uint16_t)1
24 #define RTE_PORT_CLOSED         (uint16_t)2
25 #define RTE_PORT_HANDLING       (uint16_t)3
26
27 /*
28  * It is used to allocate the memory for hash key.
29  * The hash key size is NIC dependent.
30  */
31 #define RSS_HASH_KEY_LENGTH 64
32
33 /*
34  * Default size of the mbuf data buffer to receive standard 1518-byte
35  * Ethernet frames in a mono-segment memory buffer.
36  */
37 #define DEFAULT_MBUF_DATA_SIZE RTE_MBUF_DEFAULT_BUF_SIZE
38 /**< Default size of mbuf data buffer. */
39
40 /*
41  * The maximum number of segments per packet is used when creating
42  * scattered transmit packets composed of a list of mbufs.
43  */
44 #define RTE_MAX_SEGS_PER_PKT 255 /**< nb_segs is a 8-bit unsigned char. */
45
46 /*
47  * The maximum number of segments per packet is used to configure
48  * buffer split feature, also specifies the maximum amount of
49  * optional Rx pools to allocate mbufs to split.
50  */
51 #define MAX_SEGS_BUFFER_SPLIT 8 /**< nb_segs is a 8-bit unsigned char. */
52
53 /* The prefix of the mbuf pool names created by the application. */
54 #define MBUF_POOL_NAME_PFX "mb_pool"
55
56 #define MAX_PKT_BURST 512
57 #define DEF_PKT_BURST 32
58
59 #define DEF_MBUF_CACHE 250
60
61 #define RTE_CACHE_LINE_SIZE_ROUNDUP(size) \
62         (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
63
64 #define NUMA_NO_CONFIG 0xFF
65 #define UMA_NO_CONFIG  0xFF
66
67 typedef uint8_t  lcoreid_t;
68 typedef uint16_t portid_t;
69 typedef uint16_t queueid_t;
70 typedef uint16_t streamid_t;
71
72 enum {
73         PORT_TOPOLOGY_PAIRED,
74         PORT_TOPOLOGY_CHAINED,
75         PORT_TOPOLOGY_LOOP,
76 };
77
78 enum {
79         MP_ALLOC_NATIVE, /**< allocate and populate mempool natively */
80         MP_ALLOC_ANON,
81         /**< allocate mempool natively, but populate using anonymous memory */
82         MP_ALLOC_XMEM,
83         /**< allocate and populate mempool using anonymous memory */
84         MP_ALLOC_XMEM_HUGE,
85         /**< allocate and populate mempool using anonymous hugepage memory */
86         MP_ALLOC_XBUF
87         /**< allocate mempool natively, use rte_pktmbuf_pool_create_extbuf */
88 };
89
90 /**
91  * The data structure associated with RX and TX packet burst statistics
92  * that are recorded for each forwarding stream.
93  */
94 struct pkt_burst_stats {
95         unsigned int pkt_burst_spread[MAX_PKT_BURST];
96 };
97
98 /** Information for a given RSS type. */
99 struct rss_type_info {
100         const char *str; /**< Type name. */
101         uint64_t rss_type; /**< Type value. */
102 };
103
104 /**
105  * RSS type information table.
106  *
107  * An entry with a NULL type name terminates the list.
108  */
109 extern const struct rss_type_info rss_type_table[];
110
111 /**
112  * Dynf name array.
113  *
114  * Array that holds the name for each dynf.
115  */
116 extern char dynf_names[64][RTE_MBUF_DYN_NAMESIZE];
117
118 /**
119  * The data structure associated with a forwarding stream between a receive
120  * port/queue and a transmit port/queue.
121  */
122 struct fwd_stream {
123         /* "read-only" data */
124         portid_t   rx_port;   /**< port to poll for received packets */
125         queueid_t  rx_queue;  /**< RX queue to poll on "rx_port" */
126         portid_t   tx_port;   /**< forwarding port of received packets */
127         queueid_t  tx_queue;  /**< TX queue to send forwarded packets */
128         streamid_t peer_addr; /**< index of peer ethernet address of packets */
129
130         unsigned int retry_enabled;
131
132         /* "read-write" results */
133         uint64_t rx_packets;  /**< received packets */
134         uint64_t tx_packets;  /**< received packets transmitted */
135         uint64_t fwd_dropped; /**< received packets not forwarded */
136         uint64_t rx_bad_ip_csum ; /**< received packets has bad ip checksum */
137         uint64_t rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
138         uint64_t rx_bad_outer_l4_csum;
139         /**< received packets has bad outer l4 checksum */
140         unsigned int gro_times; /**< GRO operation times */
141         uint64_t     core_cycles; /**< used for RX and TX processing */
142         struct pkt_burst_stats rx_burst_stats;
143         struct pkt_burst_stats tx_burst_stats;
144 };
145
146 /** Descriptor for a single flow. */
147 struct port_flow {
148         struct port_flow *next; /**< Next flow in list. */
149         struct port_flow *tmp; /**< Temporary linking. */
150         uint32_t id; /**< Flow rule ID. */
151         struct rte_flow *flow; /**< Opaque flow object returned by PMD. */
152         struct rte_flow_conv_rule rule; /* Saved flow rule description. */
153         uint8_t data[]; /**< Storage for flow rule description */
154 };
155
156 /* Descriptor for shared action */
157 struct port_shared_action {
158         struct port_shared_action *next; /**< Next flow in list. */
159         uint32_t id; /**< Shared action ID. */
160         enum rte_flow_action_type type; /**< Action type. */
161         struct rte_flow_shared_action *action;  /**< Shared action handle. */
162 };
163
164 struct port_flow_tunnel {
165         LIST_ENTRY(port_flow_tunnel) chain;
166         struct rte_flow_action *pmd_actions;
167         struct rte_flow_item   *pmd_items;
168         uint32_t id;
169         uint32_t num_pmd_actions;
170         uint32_t num_pmd_items;
171         struct rte_flow_tunnel tunnel;
172         struct rte_flow_action *actions;
173         struct rte_flow_item *items;
174 };
175
176 struct tunnel_ops {
177         uint32_t id;
178         char type[16];
179         uint32_t enabled:1;
180         uint32_t actions:1;
181         uint32_t items:1;
182 };
183
184 /**
185  * The data structure associated with each port.
186  */
187 struct rte_port {
188         struct rte_eth_dev_info dev_info;   /**< PCI info + driver name */
189         struct rte_eth_conf     dev_conf;   /**< Port configuration. */
190         struct rte_ether_addr       eth_addr;   /**< Port ethernet address */
191         struct rte_eth_stats    stats;      /**< Last port statistics */
192         unsigned int            socket_id;  /**< For NUMA support */
193         uint16_t                parse_tunnel:1; /**< Parse internal headers */
194         uint16_t                tso_segsz;  /**< Segmentation offload MSS for non-tunneled packets. */
195         uint16_t                tunnel_tso_segsz; /**< Segmentation offload MSS for tunneled pkts. */
196         uint16_t                tx_vlan_id;/**< The tag ID */
197         uint16_t                tx_vlan_id_outer;/**< The outer tag ID */
198         uint8_t                 tx_queue_stats_mapping_enabled;
199         uint8_t                 rx_queue_stats_mapping_enabled;
200         volatile uint16_t        port_status;    /**< port started or not */
201         uint8_t                 need_setup;     /**< port just attached */
202         uint8_t                 need_reconfig;  /**< need reconfiguring port or not */
203         uint8_t                 need_reconfig_queues; /**< need reconfiguring queues or not */
204         uint8_t                 rss_flag;   /**< enable rss or not */
205         uint8_t                 dcb_flag;   /**< enable dcb */
206         uint16_t                nb_rx_desc[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue rx desc number */
207         uint16_t                nb_tx_desc[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue tx desc number */
208         struct rte_eth_rxconf   rx_conf[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue rx configuration */
209         struct rte_eth_txconf   tx_conf[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue tx configuration */
210         struct rte_ether_addr   *mc_addr_pool; /**< pool of multicast addrs */
211         uint32_t                mc_addr_nb; /**< nb. of addr. in mc_addr_pool */
212         uint8_t                 slave_flag; /**< bonding slave port */
213         struct port_flow        *flow_list; /**< Associated flows. */
214         struct port_shared_action *actions_list;
215         /**< Associated shared actions. */
216         LIST_HEAD(, port_flow_tunnel) flow_tunnel_list;
217         const struct rte_eth_rxtx_callback *rx_dump_cb[RTE_MAX_QUEUES_PER_PORT+1];
218         const struct rte_eth_rxtx_callback *tx_dump_cb[RTE_MAX_QUEUES_PER_PORT+1];
219         /**< metadata value to insert in Tx packets. */
220         uint32_t                tx_metadata;
221         const struct rte_eth_rxtx_callback *tx_set_md_cb[RTE_MAX_QUEUES_PER_PORT+1];
222         /**< dynamic flags. */
223         uint64_t                mbuf_dynf;
224         const struct rte_eth_rxtx_callback *tx_set_dynf_cb[RTE_MAX_QUEUES_PER_PORT+1];
225 };
226
227 /**
228  * The data structure associated with each forwarding logical core.
229  * The logical cores are internally numbered by a core index from 0 to
230  * the maximum number of logical cores - 1.
231  * The system CPU identifier of all logical cores are setup in a global
232  * CPU id. configuration table.
233  */
234 struct fwd_lcore {
235         struct rte_gso_ctx gso_ctx;     /**< GSO context */
236         struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
237         void *gro_ctx;          /**< GRO context */
238         streamid_t stream_idx;   /**< index of 1st stream in "fwd_streams" */
239         streamid_t stream_nb;    /**< number of streams in "fwd_streams" */
240         lcoreid_t  cpuid_idx;    /**< index of logical core in CPU id table */
241         queueid_t  tx_queue;     /**< TX queue to send forwarded packets */
242         volatile char stopped;   /**< stop forwarding when set */
243 };
244
245 /*
246  * Forwarding mode operations:
247  *   - IO forwarding mode (default mode)
248  *     Forwards packets unchanged.
249  *
250  *   - MAC forwarding mode
251  *     Set the source and the destination Ethernet addresses of packets
252  *     before forwarding them.
253  *
254  *   - IEEE1588 forwarding mode
255  *     Check that received IEEE1588 Precise Time Protocol (PTP) packets are
256  *     filtered and timestamped by the hardware.
257  *     Forwards packets unchanged on the same port.
258  *     Check that sent IEEE1588 PTP packets are timestamped by the hardware.
259  */
260 typedef void (*port_fwd_begin_t)(portid_t pi);
261 typedef void (*port_fwd_end_t)(portid_t pi);
262 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
263
264 struct fwd_engine {
265         const char       *fwd_mode_name; /**< Forwarding mode name. */
266         port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
267         port_fwd_end_t   port_fwd_end;   /**< NULL if nothing special to do. */
268         packet_fwd_t     packet_fwd;     /**< Mandatory. */
269 };
270
271 #define BURST_TX_WAIT_US 1
272 #define BURST_TX_RETRIES 64
273
274 extern uint32_t burst_tx_delay_time;
275 extern uint32_t burst_tx_retry_num;
276
277 extern struct fwd_engine io_fwd_engine;
278 extern struct fwd_engine mac_fwd_engine;
279 extern struct fwd_engine mac_swap_engine;
280 extern struct fwd_engine flow_gen_engine;
281 extern struct fwd_engine rx_only_engine;
282 extern struct fwd_engine tx_only_engine;
283 extern struct fwd_engine csum_fwd_engine;
284 extern struct fwd_engine icmp_echo_engine;
285 extern struct fwd_engine noisy_vnf_engine;
286 extern struct fwd_engine five_tuple_swap_fwd_engine;
287 #ifdef RTE_LIBRTE_IEEE1588
288 extern struct fwd_engine ieee1588_fwd_engine;
289 #endif
290
291 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
292 extern cmdline_parse_inst_t cmd_set_raw;
293 extern cmdline_parse_inst_t cmd_show_set_raw;
294 extern cmdline_parse_inst_t cmd_show_set_raw_all;
295
296 extern uint16_t mempool_flags;
297
298 /**
299  * Forwarding Configuration
300  *
301  */
302 struct fwd_config {
303         struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
304         streamid_t nb_fwd_streams;  /**< Nb. of forward streams to process. */
305         lcoreid_t  nb_fwd_lcores;   /**< Nb. of logical cores to launch. */
306         portid_t   nb_fwd_ports;    /**< Nb. of ports involved. */
307 };
308
309 /**
310  * DCB mode enable
311  */
312 enum dcb_mode_enable
313 {
314         DCB_VT_ENABLED,
315         DCB_ENABLED
316 };
317
318 #define MAX_TX_QUEUE_STATS_MAPPINGS 1024 /* MAX_PORT of 32 @ 32 tx_queues/port */
319 #define MAX_RX_QUEUE_STATS_MAPPINGS 4096 /* MAX_PORT of 32 @ 128 rx_queues/port */
320
321 struct queue_stats_mappings {
322         portid_t port_id;
323         uint16_t queue_id;
324         uint8_t stats_counter_id;
325 } __rte_cache_aligned;
326
327 extern struct queue_stats_mappings tx_queue_stats_mappings_array[];
328 extern struct queue_stats_mappings rx_queue_stats_mappings_array[];
329
330 /* Assign both tx and rx queue stats mappings to the same default values */
331 extern struct queue_stats_mappings *tx_queue_stats_mappings;
332 extern struct queue_stats_mappings *rx_queue_stats_mappings;
333
334 extern uint16_t nb_tx_queue_stats_mappings;
335 extern uint16_t nb_rx_queue_stats_mappings;
336
337 extern uint8_t xstats_hide_zero; /**< Hide zero values for xstats display */
338
339 /* globals used for configuration */
340 extern uint8_t record_core_cycles; /**< Enables measurement of CPU cycles */
341 extern uint8_t record_burst_stats; /**< Enables display of RX and TX bursts */
342 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
343 extern int testpmd_logtype; /**< Log type for testpmd logs */
344 extern uint8_t  interactive;
345 extern uint8_t  auto_start;
346 extern uint8_t  tx_first;
347 extern char cmdline_filename[PATH_MAX]; /**< offline commands file */
348 extern uint8_t  numa_support; /**< set by "--numa" parameter */
349 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
350 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
351 extern uint8_t flow_isolate_all; /**< set by "--flow-isolate-all */
352 extern uint8_t  mp_alloc_type;
353 /**< set by "--mp-anon" or "--mp-alloc" parameter */
354 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
355 extern uint8_t no_device_start; /**<set by "--disable-device-start" parameter */
356 extern volatile int test_done; /* stop packet forwarding when set to 1. */
357 extern uint8_t lsc_interrupt; /**< disabled by "--no-lsc-interrupt" parameter */
358 extern uint8_t rmv_interrupt; /**< disabled by "--no-rmv-interrupt" parameter */
359 extern uint32_t event_print_mask;
360 /**< set by "--print-event xxxx" and "--mask-event xxxx parameters */
361 extern bool setup_on_probe_event; /**< disabled by port setup-on iterator */
362 extern uint8_t hot_plug; /**< enable by "--hot-plug" parameter */
363 extern int do_mlockall; /**< set by "--mlockall" or "--no-mlockall" parameter */
364 extern uint8_t clear_ptypes; /**< disabled by set ptype cmd */
365
366 #ifdef RTE_LIBRTE_IXGBE_BYPASS
367 extern uint32_t bypass_timeout; /**< Store the NIC bypass watchdog timeout */
368 #endif
369
370 /*
371  * Store specified sockets on which memory pool to be used by ports
372  * is allocated.
373  */
374 extern uint8_t port_numa[RTE_MAX_ETHPORTS];
375
376 /*
377  * Store specified sockets on which RX ring to be used by ports
378  * is allocated.
379  */
380 extern uint8_t rxring_numa[RTE_MAX_ETHPORTS];
381
382 /*
383  * Store specified sockets on which TX ring to be used by ports
384  * is allocated.
385  */
386 extern uint8_t txring_numa[RTE_MAX_ETHPORTS];
387
388 extern uint8_t socket_num;
389
390 /*
391  * Configuration of logical cores:
392  * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
393  */
394 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
395 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
396 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
397 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
398 extern unsigned int num_sockets;
399 extern unsigned int socket_ids[RTE_MAX_NUMA_NODES];
400
401 /*
402  * Configuration of Ethernet ports:
403  * nb_fwd_ports <= nb_cfg_ports <= nb_ports
404  */
405 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
406 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
407 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
408 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
409 extern struct rte_port *ports;
410
411 extern struct rte_eth_rxmode rx_mode;
412 extern struct rte_eth_txmode tx_mode;
413
414 extern uint64_t rss_hf;
415
416 extern queueid_t nb_hairpinq;
417 extern queueid_t nb_rxq;
418 extern queueid_t nb_txq;
419
420 extern uint16_t nb_rxd;
421 extern uint16_t nb_txd;
422
423 extern int16_t rx_free_thresh;
424 extern int8_t rx_drop_en;
425 extern int16_t tx_free_thresh;
426 extern int16_t tx_rs_thresh;
427
428 extern uint16_t noisy_tx_sw_bufsz;
429 extern uint16_t noisy_tx_sw_buf_flush_time;
430 extern uint64_t noisy_lkup_mem_sz;
431 extern uint64_t noisy_lkup_num_writes;
432 extern uint64_t noisy_lkup_num_reads;
433 extern uint64_t noisy_lkup_num_reads_writes;
434
435 extern uint8_t dcb_config;
436 extern uint8_t dcb_test;
437
438 extern uint32_t mbuf_data_size_n;
439 extern uint16_t mbuf_data_size[MAX_SEGS_BUFFER_SPLIT];
440 /**< Mbuf data space size. */
441 extern uint32_t param_total_num_mbufs;
442
443 extern uint16_t stats_period;
444
445 extern uint16_t hairpin_mode;
446
447 #ifdef RTE_LIBRTE_LATENCY_STATS
448 extern uint8_t latencystats_enabled;
449 extern lcoreid_t latencystats_lcore_id;
450 #endif
451
452 #ifdef RTE_LIBRTE_BITRATESTATS
453 extern lcoreid_t bitrate_lcore_id;
454 extern uint8_t bitrate_enabled;
455 #endif
456
457 extern struct rte_fdir_conf fdir_conf;
458
459 /*
460  * Configuration of packet segments used to scatter received packets
461  * if some of split features is configured.
462  */
463 extern uint16_t rx_pkt_seg_lengths[MAX_SEGS_BUFFER_SPLIT];
464 extern uint8_t  rx_pkt_nb_segs; /**< Number of segments to split */
465 extern uint16_t rx_pkt_seg_offsets[MAX_SEGS_BUFFER_SPLIT];
466 extern uint8_t  rx_pkt_nb_offs; /**< Number of specified offsets */
467
468 /*
469  * Configuration of packet segments used by the "txonly" processing engine.
470  */
471 #define TXONLY_DEF_PACKET_LEN 64
472 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
473 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
474 extern uint8_t  tx_pkt_nb_segs; /**< Number of segments in TX packets */
475 extern uint32_t tx_pkt_times_intra;
476 extern uint32_t tx_pkt_times_inter;
477
478 enum tx_pkt_split {
479         TX_PKT_SPLIT_OFF,
480         TX_PKT_SPLIT_ON,
481         TX_PKT_SPLIT_RND,
482 };
483
484 extern enum tx_pkt_split tx_pkt_split;
485
486 extern uint8_t txonly_multi_flow;
487
488 extern uint16_t nb_pkt_per_burst;
489 extern uint16_t mb_mempool_cache;
490 extern int8_t rx_pthresh;
491 extern int8_t rx_hthresh;
492 extern int8_t rx_wthresh;
493 extern int8_t tx_pthresh;
494 extern int8_t tx_hthresh;
495 extern int8_t tx_wthresh;
496
497 extern uint16_t tx_udp_src_port;
498 extern uint16_t tx_udp_dst_port;
499
500 extern uint32_t tx_ip_src_addr;
501 extern uint32_t tx_ip_dst_addr;
502
503 extern struct fwd_config cur_fwd_config;
504 extern struct fwd_engine *cur_fwd_eng;
505 extern uint32_t retry_enabled;
506 extern struct fwd_lcore  **fwd_lcores;
507 extern struct fwd_stream **fwd_streams;
508
509 extern uint16_t vxlan_gpe_udp_port; /**< UDP port of tunnel VXLAN-GPE. */
510 extern uint16_t geneve_udp_port; /**< UDP port of tunnel GENEVE. */
511
512 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
513 extern struct rte_ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
514
515 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
516 extern uint32_t burst_tx_retry_num;  /**< Burst tx retry number for mac-retry. */
517
518 #define GRO_DEFAULT_ITEM_NUM_PER_FLOW 32
519 #define GRO_DEFAULT_FLOW_NUM (RTE_GRO_MAX_BURST_ITEM_NUM / \
520                 GRO_DEFAULT_ITEM_NUM_PER_FLOW)
521
522 #define GRO_DEFAULT_FLUSH_CYCLES 1
523 #define GRO_MAX_FLUSH_CYCLES 4
524
525 struct gro_status {
526         struct rte_gro_param param;
527         uint8_t enable;
528 };
529 extern struct gro_status gro_ports[RTE_MAX_ETHPORTS];
530 extern uint8_t gro_flush_cycles;
531
532 #define GSO_MAX_PKT_BURST 2048
533 struct gso_status {
534         uint8_t enable;
535 };
536 extern struct gso_status gso_ports[RTE_MAX_ETHPORTS];
537 extern uint16_t gso_max_segment_size;
538
539 /* VXLAN encap/decap parameters. */
540 struct vxlan_encap_conf {
541         uint32_t select_ipv4:1;
542         uint32_t select_vlan:1;
543         uint32_t select_tos_ttl:1;
544         uint8_t vni[3];
545         rte_be16_t udp_src;
546         rte_be16_t udp_dst;
547         rte_be32_t ipv4_src;
548         rte_be32_t ipv4_dst;
549         uint8_t ipv6_src[16];
550         uint8_t ipv6_dst[16];
551         rte_be16_t vlan_tci;
552         uint8_t ip_tos;
553         uint8_t ip_ttl;
554         uint8_t eth_src[RTE_ETHER_ADDR_LEN];
555         uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
556 };
557
558 extern struct vxlan_encap_conf vxlan_encap_conf;
559
560 /* NVGRE encap/decap parameters. */
561 struct nvgre_encap_conf {
562         uint32_t select_ipv4:1;
563         uint32_t select_vlan:1;
564         uint8_t tni[3];
565         rte_be32_t ipv4_src;
566         rte_be32_t ipv4_dst;
567         uint8_t ipv6_src[16];
568         uint8_t ipv6_dst[16];
569         rte_be16_t vlan_tci;
570         uint8_t eth_src[RTE_ETHER_ADDR_LEN];
571         uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
572 };
573
574 extern struct nvgre_encap_conf nvgre_encap_conf;
575
576 /* L2 encap parameters. */
577 struct l2_encap_conf {
578         uint32_t select_ipv4:1;
579         uint32_t select_vlan:1;
580         rte_be16_t vlan_tci;
581         uint8_t eth_src[RTE_ETHER_ADDR_LEN];
582         uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
583 };
584 extern struct l2_encap_conf l2_encap_conf;
585
586 /* L2 decap parameters. */
587 struct l2_decap_conf {
588         uint32_t select_vlan:1;
589 };
590 extern struct l2_decap_conf l2_decap_conf;
591
592 /* MPLSoGRE encap parameters. */
593 struct mplsogre_encap_conf {
594         uint32_t select_ipv4:1;
595         uint32_t select_vlan:1;
596         uint8_t label[3];
597         rte_be32_t ipv4_src;
598         rte_be32_t ipv4_dst;
599         uint8_t ipv6_src[16];
600         uint8_t ipv6_dst[16];
601         rte_be16_t vlan_tci;
602         uint8_t eth_src[RTE_ETHER_ADDR_LEN];
603         uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
604 };
605 extern struct mplsogre_encap_conf mplsogre_encap_conf;
606
607 /* MPLSoGRE decap parameters. */
608 struct mplsogre_decap_conf {
609         uint32_t select_ipv4:1;
610         uint32_t select_vlan:1;
611 };
612 extern struct mplsogre_decap_conf mplsogre_decap_conf;
613
614 /* MPLSoUDP encap parameters. */
615 struct mplsoudp_encap_conf {
616         uint32_t select_ipv4:1;
617         uint32_t select_vlan:1;
618         uint8_t label[3];
619         rte_be16_t udp_src;
620         rte_be16_t udp_dst;
621         rte_be32_t ipv4_src;
622         rte_be32_t ipv4_dst;
623         uint8_t ipv6_src[16];
624         uint8_t ipv6_dst[16];
625         rte_be16_t vlan_tci;
626         uint8_t eth_src[RTE_ETHER_ADDR_LEN];
627         uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
628 };
629 extern struct mplsoudp_encap_conf mplsoudp_encap_conf;
630
631 /* MPLSoUDP decap parameters. */
632 struct mplsoudp_decap_conf {
633         uint32_t select_ipv4:1;
634         uint32_t select_vlan:1;
635 };
636 extern struct mplsoudp_decap_conf mplsoudp_decap_conf;
637
638 extern enum rte_eth_rx_mq_mode rx_mq_mode;
639
640 static inline unsigned int
641 lcore_num(void)
642 {
643         unsigned int i;
644
645         for (i = 0; i < RTE_MAX_LCORE; ++i)
646                 if (fwd_lcores_cpuids[i] == rte_lcore_id())
647                         return i;
648
649         rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
650 }
651
652 void
653 parse_fwd_portlist(const char *port);
654
655 static inline struct fwd_lcore *
656 current_fwd_lcore(void)
657 {
658         return fwd_lcores[lcore_num()];
659 }
660
661 /* Mbuf Pools */
662 static inline void
663 mbuf_poolname_build(unsigned int sock_id, char *mp_name,
664                     int name_size, uint16_t idx)
665 {
666         if (!idx)
667                 snprintf(mp_name, name_size,
668                          MBUF_POOL_NAME_PFX "_%u", sock_id);
669         else
670                 snprintf(mp_name, name_size,
671                          MBUF_POOL_NAME_PFX "_%hu_%hu", (uint16_t)sock_id, idx);
672 }
673
674 static inline struct rte_mempool *
675 mbuf_pool_find(unsigned int sock_id, uint16_t idx)
676 {
677         char pool_name[RTE_MEMPOOL_NAMESIZE];
678
679         mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name), idx);
680         return rte_mempool_lookup((const char *)pool_name);
681 }
682
683 /**
684  * Read/Write operations on a PCI register of a port.
685  */
686 static inline uint32_t
687 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
688 {
689         const struct rte_pci_device *pci_dev;
690         const struct rte_bus *bus;
691         void *reg_addr;
692         uint32_t reg_v;
693
694         if (!port->dev_info.device) {
695                 printf("Invalid device\n");
696                 return 0;
697         }
698
699         bus = rte_bus_find_by_device(port->dev_info.device);
700         if (bus && !strcmp(bus->name, "pci")) {
701                 pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
702         } else {
703                 printf("Not a PCI device\n");
704                 return 0;
705         }
706
707         reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
708         reg_v = *((volatile uint32_t *)reg_addr);
709         return rte_le_to_cpu_32(reg_v);
710 }
711
712 #define port_id_pci_reg_read(pt_id, reg_off) \
713         port_pci_reg_read(&ports[(pt_id)], (reg_off))
714
715 static inline void
716 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
717 {
718         const struct rte_pci_device *pci_dev;
719         const struct rte_bus *bus;
720         void *reg_addr;
721
722         if (!port->dev_info.device) {
723                 printf("Invalid device\n");
724                 return;
725         }
726
727         bus = rte_bus_find_by_device(port->dev_info.device);
728         if (bus && !strcmp(bus->name, "pci")) {
729                 pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
730         } else {
731                 printf("Not a PCI device\n");
732                 return;
733         }
734
735         reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
736         *((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
737 }
738
739 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
740         port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
741
742 static inline void
743 get_start_cycles(uint64_t *start_tsc)
744 {
745         if (record_core_cycles)
746                 *start_tsc = rte_rdtsc();
747 }
748
749 static inline void
750 get_end_cycles(struct fwd_stream *fs, uint64_t start_tsc)
751 {
752         if (record_core_cycles)
753                 fs->core_cycles += rte_rdtsc() - start_tsc;
754 }
755
756 static inline void
757 inc_rx_burst_stats(struct fwd_stream *fs, uint16_t nb_rx)
758 {
759         if (record_burst_stats)
760                 fs->rx_burst_stats.pkt_burst_spread[nb_rx]++;
761 }
762
763 static inline void
764 inc_tx_burst_stats(struct fwd_stream *fs, uint16_t nb_tx)
765 {
766         if (record_burst_stats)
767                 fs->tx_burst_stats.pkt_burst_spread[nb_tx]++;
768 }
769
770 /* Prototypes */
771 unsigned int parse_item_list(char* str, const char* item_name,
772                         unsigned int max_items,
773                         unsigned int *parsed_items, int check_unique_values);
774 void launch_args_parse(int argc, char** argv);
775 void cmdline_read_from_file(const char *filename);
776 void prompt(void);
777 void prompt_exit(void);
778 void nic_stats_display(portid_t port_id);
779 void nic_stats_clear(portid_t port_id);
780 void nic_xstats_display(portid_t port_id);
781 void nic_xstats_clear(portid_t port_id);
782 void nic_stats_mapping_display(portid_t port_id);
783 void device_infos_display(const char *identifier);
784 void port_infos_display(portid_t port_id);
785 void port_summary_display(portid_t port_id);
786 void port_eeprom_display(portid_t port_id);
787 void port_module_eeprom_display(portid_t port_id);
788 void port_summary_header_display(void);
789 void port_offload_cap_display(portid_t port_id);
790 void rx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
791 void tx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
792 void fwd_lcores_config_display(void);
793 void pkt_fwd_config_display(struct fwd_config *cfg);
794 void rxtx_config_display(void);
795 void fwd_config_setup(void);
796 void set_def_fwd_config(void);
797 void reconfig(portid_t new_port_id, unsigned socket_id);
798 int init_fwd_streams(void);
799 void update_fwd_ports(portid_t new_pid);
800
801 void set_fwd_eth_peer(portid_t port_id, char *peer_addr);
802
803 void port_mtu_set(portid_t port_id, uint16_t mtu);
804 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
805 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
806                       uint8_t bit_v);
807 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
808                                 uint8_t bit1_pos, uint8_t bit2_pos);
809 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
810                             uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
811 void port_reg_display(portid_t port_id, uint32_t reg_off);
812 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
813 int port_shared_action_create(portid_t port_id, uint32_t id,
814                               const struct rte_flow_shared_action_conf *conf,
815                               const struct rte_flow_action *action);
816 int port_shared_action_destroy(portid_t port_id,
817                                uint32_t n, const uint32_t *action);
818 struct rte_flow_shared_action *port_shared_action_get_by_id(portid_t port_id,
819                                                             uint32_t id);
820 int port_shared_action_update(portid_t port_id, uint32_t id,
821                               const struct rte_flow_action *action);
822 int port_flow_validate(portid_t port_id,
823                        const struct rte_flow_attr *attr,
824                        const struct rte_flow_item *pattern,
825                        const struct rte_flow_action *actions,
826                        const struct tunnel_ops *tunnel_ops);
827 int port_flow_create(portid_t port_id,
828                      const struct rte_flow_attr *attr,
829                      const struct rte_flow_item *pattern,
830                      const struct rte_flow_action *actions,
831                      const struct tunnel_ops *tunnel_ops);
832 int port_shared_action_query(portid_t port_id, uint32_t id);
833 void update_age_action_context(const struct rte_flow_action *actions,
834                      struct port_flow *pf);
835 int port_flow_destroy(portid_t port_id, uint32_t n, const uint32_t *rule);
836 int port_flow_flush(portid_t port_id);
837 int port_flow_dump(portid_t port_id, const char *file_name);
838 int port_flow_query(portid_t port_id, uint32_t rule,
839                     const struct rte_flow_action *action);
840 void port_flow_list(portid_t port_id, uint32_t n, const uint32_t *group);
841 void port_flow_aged(portid_t port_id, uint8_t destroy);
842 const char *port_flow_tunnel_type(struct rte_flow_tunnel *tunnel);
843 struct port_flow_tunnel *
844 port_flow_locate_tunnel(uint16_t port_id, struct rte_flow_tunnel *tun);
845 void port_flow_tunnel_list(portid_t port_id);
846 void port_flow_tunnel_destroy(portid_t port_id, uint32_t tunnel_id);
847 void port_flow_tunnel_create(portid_t port_id, const struct tunnel_ops *ops);
848 int port_flow_isolate(portid_t port_id, int set);
849
850 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
851 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
852
853 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
854 int set_fwd_lcores_mask(uint64_t lcoremask);
855 void set_fwd_lcores_number(uint16_t nb_lc);
856
857 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
858 void set_fwd_ports_mask(uint64_t portmask);
859 void set_fwd_ports_number(uint16_t nb_pt);
860 int port_is_forwarding(portid_t port_id);
861
862 void rx_vlan_strip_set(portid_t port_id, int on);
863 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
864
865 void rx_vlan_filter_set(portid_t port_id, int on);
866 void rx_vlan_all_filter_set(portid_t port_id, int on);
867 void rx_vlan_qinq_strip_set(portid_t port_id, int on);
868 int rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
869 void vlan_extend_set(portid_t port_id, int on);
870 void vlan_tpid_set(portid_t port_id, enum rte_vlan_type vlan_type,
871                    uint16_t tp_id);
872 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
873 void tx_qinq_set(portid_t port_id, uint16_t vlan_id, uint16_t vlan_id_outer);
874 void tx_vlan_reset(portid_t port_id);
875 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
876
877 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
878
879 void set_xstats_hide_zero(uint8_t on_off);
880
881 void set_record_core_cycles(uint8_t on_off);
882 void set_record_burst_stats(uint8_t on_off);
883 void set_verbose_level(uint16_t vb_level);
884 void set_rx_pkt_segments(unsigned int *seg_lengths, unsigned int nb_segs);
885 void show_rx_pkt_segments(void);
886 void set_rx_pkt_offsets(unsigned int *seg_offsets, unsigned int nb_offs);
887 void show_rx_pkt_offsets(void);
888 void set_tx_pkt_segments(unsigned int *seg_lengths, unsigned int nb_segs);
889 void show_tx_pkt_segments(void);
890 void set_tx_pkt_times(unsigned int *tx_times);
891 void show_tx_pkt_times(void);
892 void set_tx_pkt_split(const char *name);
893 int parse_fec_mode(const char *name, enum rte_eth_fec_mode *mode);
894 void show_fec_capability(uint32_t num, struct rte_eth_fec_capa *speed_fec_capa);
895 void set_nb_pkt_per_burst(uint16_t pkt_burst);
896 char *list_pkt_forwarding_modes(void);
897 char *list_pkt_forwarding_retry_modes(void);
898 void set_pkt_forwarding_mode(const char *fwd_mode);
899 void start_packet_forwarding(int with_tx_first);
900 void fwd_stats_display(void);
901 void fwd_stats_reset(void);
902 void stop_packet_forwarding(void);
903 void dev_set_link_up(portid_t pid);
904 void dev_set_link_down(portid_t pid);
905 void init_port_config(void);
906 void set_port_slave_flag(portid_t slave_pid);
907 void clear_port_slave_flag(portid_t slave_pid);
908 uint8_t port_is_bonding_slave(portid_t slave_pid);
909
910 int init_port_dcb_config(portid_t pid, enum dcb_mode_enable dcb_mode,
911                      enum rte_eth_nb_tcs num_tcs,
912                      uint8_t pfc_en);
913 int start_port(portid_t pid);
914 void stop_port(portid_t pid);
915 void close_port(portid_t pid);
916 void reset_port(portid_t pid);
917 void attach_port(char *identifier);
918 void detach_devargs(char *identifier);
919 void detach_port_device(portid_t port_id);
920 int all_ports_stopped(void);
921 int port_is_stopped(portid_t port_id);
922 int port_is_started(portid_t port_id);
923 void pmd_test_exit(void);
924 void fdir_get_infos(portid_t port_id);
925 void fdir_set_flex_mask(portid_t port_id,
926                            struct rte_eth_fdir_flex_mask *cfg);
927 void fdir_set_flex_payload(portid_t port_id,
928                            struct rte_eth_flex_payload_cfg *cfg);
929 void port_rss_reta_info(portid_t port_id,
930                         struct rte_eth_rss_reta_entry64 *reta_conf,
931                         uint16_t nb_entries);
932
933 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
934
935 int
936 rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
937                uint16_t nb_rx_desc, unsigned int socket_id,
938                struct rte_eth_rxconf *rx_conf, struct rte_mempool *mp);
939
940 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
941 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
942                                 uint64_t q_msk);
943
944 void port_rss_hash_conf_show(portid_t port_id, int show_rss_key);
945 void port_rss_hash_key_update(portid_t port_id, char rss_type[],
946                               uint8_t *hash_key, uint hash_key_len);
947 int rx_queue_id_is_invalid(queueid_t rxq_id);
948 int tx_queue_id_is_invalid(queueid_t txq_id);
949 void setup_gro(const char *onoff, portid_t port_id);
950 void setup_gro_flush_cycles(uint8_t cycles);
951 void show_gro(portid_t port_id);
952 void setup_gso(const char *mode, portid_t port_id);
953 int eth_dev_info_get_print_err(uint16_t port_id,
954                         struct rte_eth_dev_info *dev_info);
955 void eth_set_promisc_mode(uint16_t port_id, int enable);
956 void eth_set_allmulticast_mode(uint16_t port, int enable);
957 int eth_link_get_nowait_print_err(uint16_t port_id, struct rte_eth_link *link);
958 int eth_macaddr_get_print_err(uint16_t port_id,
959                         struct rte_ether_addr *mac_addr);
960
961 /* Functions to display the set of MAC addresses added to a port*/
962 void show_macs(portid_t port_id);
963 void show_mcast_macs(portid_t port_id);
964
965 /* Functions to manage the set of filtered Multicast MAC addresses */
966 void mcast_addr_add(portid_t port_id, struct rte_ether_addr *mc_addr);
967 void mcast_addr_remove(portid_t port_id, struct rte_ether_addr *mc_addr);
968 void port_dcb_info_display(portid_t port_id);
969
970 uint8_t *open_file(const char *file_path, uint32_t *size);
971 int save_file(const char *file_path, uint8_t *buf, uint32_t size);
972 int close_file(uint8_t *buf);
973
974 void port_queue_region_info_display(portid_t port_id, void *buf);
975
976 enum print_warning {
977         ENABLED_WARN = 0,
978         DISABLED_WARN
979 };
980 int port_id_is_invalid(portid_t port_id, enum print_warning warning);
981 void print_valid_ports(void);
982 int new_socket_id(unsigned int socket_id);
983
984 queueid_t get_allowed_max_nb_rxq(portid_t *pid);
985 int check_nb_rxq(queueid_t rxq);
986 queueid_t get_allowed_max_nb_txq(portid_t *pid);
987 int check_nb_txq(queueid_t txq);
988 int check_nb_rxd(queueid_t rxd);
989 int check_nb_txd(queueid_t txd);
990 queueid_t get_allowed_max_nb_hairpinq(portid_t *pid);
991 int check_nb_hairpinq(queueid_t hairpinq);
992
993 uint16_t dump_rx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
994                       uint16_t nb_pkts, __rte_unused uint16_t max_pkts,
995                       __rte_unused void *user_param);
996
997 uint16_t dump_tx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
998                       uint16_t nb_pkts, __rte_unused void *user_param);
999
1000 void add_rx_dump_callbacks(portid_t portid);
1001 void remove_rx_dump_callbacks(portid_t portid);
1002 void add_tx_dump_callbacks(portid_t portid);
1003 void remove_tx_dump_callbacks(portid_t portid);
1004 void configure_rxtx_dump_callbacks(uint16_t verbose);
1005
1006 uint16_t tx_pkt_set_md(uint16_t port_id, __rte_unused uint16_t queue,
1007                        struct rte_mbuf *pkts[], uint16_t nb_pkts,
1008                        __rte_unused void *user_param);
1009 void add_tx_md_callback(portid_t portid);
1010 void remove_tx_md_callback(portid_t portid);
1011
1012 uint16_t tx_pkt_set_dynf(uint16_t port_id, __rte_unused uint16_t queue,
1013                          struct rte_mbuf *pkts[], uint16_t nb_pkts,
1014                          __rte_unused void *user_param);
1015 void add_tx_dynf_callback(portid_t portid);
1016 void remove_tx_dynf_callback(portid_t portid);
1017
1018 /*
1019  * Work-around of a compilation error with ICC on invocations of the
1020  * rte_be_to_cpu_16() function.
1021  */
1022 #ifdef __GCC__
1023 #define RTE_BE_TO_CPU_16(be_16_v)  rte_be_to_cpu_16((be_16_v))
1024 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
1025 #else
1026 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
1027 #define RTE_BE_TO_CPU_16(be_16_v)  (be_16_v)
1028 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
1029 #else
1030 #define RTE_BE_TO_CPU_16(be_16_v) \
1031         (uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
1032 #define RTE_CPU_TO_BE_16(cpu_16_v) \
1033         (uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
1034 #endif
1035 #endif /* __GCC__ */
1036
1037 #define TESTPMD_LOG(level, fmt, args...) \
1038         rte_log(RTE_LOG_ ## level, testpmd_logtype, "testpmd: " fmt, ## args)
1039
1040 #endif /* _TESTPMD_H_ */