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