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