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