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