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