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