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