app/test-pmd/testpmd.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2017 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _TESTPMD_H_
  35 #define _TESTPMD_H_
  36
  37 #include <rte_pci.h>
  38 #include <rte_bus_pci.h>
  39 #include <rte_gro.h>
  40 #include <rte_gso.h>
  41
  42 #define RTE_PORT_ALL            (~(portid_t)0x0)
  43
  44 #define RTE_TEST_RX_DESC_MAX    2048
  45 #define RTE_TEST_TX_DESC_MAX    2048
  46
  47 #define RTE_PORT_STOPPED        (uint16_t)0
  48 #define RTE_PORT_STARTED        (uint16_t)1
  49 #define RTE_PORT_CLOSED         (uint16_t)2
  50 #define RTE_PORT_HANDLING       (uint16_t)3
  51
  52 /*
  53  * It is used to allocate the memory for hash key.
  54  * The hash key size is NIC dependent.
  55  */
  56 #define RSS_HASH_KEY_LENGTH 64
  57
  58 /*
  59  * Default size of the mbuf data buffer to receive standard 1518-byte
  60  * Ethernet frames in a mono-segment memory buffer.
  61  */
  62 #define DEFAULT_MBUF_DATA_SIZE RTE_MBUF_DEFAULT_BUF_SIZE
  63 /**< Default size of mbuf data buffer. */
  64
  65 /*
  66  * The maximum number of segments per packet is used when creating
  67  * scattered transmit packets composed of a list of mbufs.
  68  */
  69 #define RTE_MAX_SEGS_PER_PKT 255 /**< nb_segs is a 8-bit unsigned char. */
  70
  71 #define MAX_PKT_BURST 512
  72 #define DEF_PKT_BURST 32
  73
  74 #define DEF_MBUF_CACHE 250
  75
  76 #define RTE_CACHE_LINE_SIZE_ROUNDUP(size) \
  77         (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
  78
  79 #define NUMA_NO_CONFIG 0xFF
  80 #define UMA_NO_CONFIG  0xFF
  81
  82 typedef uint8_t  lcoreid_t;
  83 typedef uint16_t portid_t;
  84 typedef uint16_t queueid_t;
  85 typedef uint16_t streamid_t;
  86
  87 #define MAX_QUEUE_ID ((1 << (sizeof(queueid_t) * 8)) - 1)
  88
  89 #if defined RTE_LIBRTE_PMD_SOFTNIC && defined RTE_LIBRTE_SCHED
  90 #define TM_MODE                 1
  91 #else
  92 #define TM_MODE                 0
  93 #endif
  94
  95 enum {
  96         PORT_TOPOLOGY_PAIRED,
  97         PORT_TOPOLOGY_CHAINED,
  98         PORT_TOPOLOGY_LOOP,
  99 };
 100
 101 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
 102 /**
 103  * The data structure associated with RX and TX packet burst statistics
 104  * that are recorded for each forwarding stream.
 105  */
 106 struct pkt_burst_stats {
 107         unsigned int pkt_burst_spread[MAX_PKT_BURST];
 108 };
 109 #endif
 110
 111 /**
 112  * The data structure associated with a forwarding stream between a receive
 113  * port/queue and a transmit port/queue.
 114  */
 115 struct fwd_stream {
 116         /* "read-only" data */
 117         portid_t   rx_port;   /**< port to poll for received packets */
 118         queueid_t  rx_queue;  /**< RX queue to poll on "rx_port" */
 119         portid_t   tx_port;   /**< forwarding port of received packets */
 120         queueid_t  tx_queue;  /**< TX queue to send forwarded packets */
 121         streamid_t peer_addr; /**< index of peer ethernet address of packets */
 122
 123         unsigned int retry_enabled;
 124
 125         /* "read-write" results */
 126         unsigned int rx_packets;  /**< received packets */
 127         unsigned int tx_packets;  /**< received packets transmitted */
 128         unsigned int fwd_dropped; /**< received packets not forwarded */
 129         unsigned int rx_bad_ip_csum ; /**< received packets has bad ip checksum */
 130         unsigned int rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
 131         unsigned int gro_times; /**< GRO operation times */
 132 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
 133         uint64_t     core_cycles; /**< used for RX and TX processing */
 134 #endif
 135 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
 136         struct pkt_burst_stats rx_burst_stats;
 137         struct pkt_burst_stats tx_burst_stats;
 138 #endif
 139 };
 140
 141 /** Offload IP checksum in csum forward engine */
 142 #define TESTPMD_TX_OFFLOAD_IP_CKSUM          0x0001
 143 /** Offload UDP checksum in csum forward engine */
 144 #define TESTPMD_TX_OFFLOAD_UDP_CKSUM         0x0002
 145 /** Offload TCP checksum in csum forward engine */
 146 #define TESTPMD_TX_OFFLOAD_TCP_CKSUM         0x0004
 147 /** Offload SCTP checksum in csum forward engine */
 148 #define TESTPMD_TX_OFFLOAD_SCTP_CKSUM        0x0008
 149 /** Offload outer IP checksum in csum forward engine for recognized tunnels */
 150 #define TESTPMD_TX_OFFLOAD_OUTER_IP_CKSUM    0x0010
 151 /** Parse tunnel in csum forward engine. If set, dissect tunnel headers
 152  * of rx packets. If not set, treat inner headers as payload. */
 153 #define TESTPMD_TX_OFFLOAD_PARSE_TUNNEL      0x0020
 154 /** Insert VLAN header in forward engine */
 155 #define TESTPMD_TX_OFFLOAD_INSERT_VLAN       0x0040
 156 /** Insert double VLAN header in forward engine */
 157 #define TESTPMD_TX_OFFLOAD_INSERT_QINQ       0x0080
 158 /** Offload MACsec in forward engine */
 159 #define TESTPMD_TX_OFFLOAD_MACSEC            0x0100
 160
 161 /** Descriptor for a single flow. */
 162 struct port_flow {
 163         size_t size; /**< Allocated space including data[]. */
 164         struct port_flow *next; /**< Next flow in list. */
 165         struct port_flow *tmp; /**< Temporary linking. */
 166         uint32_t id; /**< Flow rule ID. */
 167         struct rte_flow *flow; /**< Opaque flow object returned by PMD. */
 168         struct rte_flow_attr attr; /**< Attributes. */
 169         struct rte_flow_item *pattern; /**< Pattern. */
 170         struct rte_flow_action *actions; /**< Actions. */
 171         uint8_t data[]; /**< Storage for pattern/actions. */
 172 };
 173
 174 #ifdef TM_MODE
 175 /**
 176  * Soft port tm related parameters
 177  */
 178 struct softnic_port_tm {
 179         uint32_t default_hierarchy_enable; /**< def hierarchy enable flag */
 180         uint32_t hierarchy_config;  /**< set to 1 if hierarchy configured */
 181
 182         uint32_t n_subports_per_port;  /**< Num of subport nodes per port */
 183         uint32_t n_pipes_per_subport;  /**< Num of pipe nodes per subport */
 184
 185         uint64_t tm_pktfield0_slabpos;  /**< Pkt field position for subport */
 186         uint64_t tm_pktfield0_slabmask; /**< Pkt field mask for the subport */
 187         uint64_t tm_pktfield0_slabshr;
 188         uint64_t tm_pktfield1_slabpos; /**< Pkt field position for the pipe */
 189         uint64_t tm_pktfield1_slabmask; /**< Pkt field mask for the pipe */
 190         uint64_t tm_pktfield1_slabshr;
 191         uint64_t tm_pktfield2_slabpos; /**< Pkt field position table index */
 192         uint64_t tm_pktfield2_slabmask; /**< Pkt field mask for tc table idx */
 193         uint64_t tm_pktfield2_slabshr;
 194         uint64_t tm_tc_table[64];  /**< TC translation table */
 195 };
 196
 197 /**
 198  * The data structure associate with softnic port
 199  */
 200 struct softnic_port {
 201         unsigned int tm_flag;   /**< set to 1 if tm feature is enabled */
 202         struct softnic_port_tm tm;      /**< softnic port tm parameters */
 203 };
 204 #endif
 205
 206 /**
 207  * The data structure associated with each port.
 208  */
 209 struct rte_port {
 210         struct rte_eth_dev_info dev_info;   /**< PCI info + driver name */
 211         struct rte_eth_conf     dev_conf;   /**< Port configuration. */
 212         struct ether_addr       eth_addr;   /**< Port ethernet address */
 213         struct rte_eth_stats    stats;      /**< Last port statistics */
 214         uint64_t                tx_dropped; /**< If no descriptor in TX ring */
 215         struct fwd_stream       *rx_stream; /**< Port RX stream, if unique */
 216         struct fwd_stream       *tx_stream; /**< Port TX stream, if unique */
 217         unsigned int            socket_id;  /**< For NUMA support */
 218         uint16_t                tx_ol_flags;/**< TX Offload Flags (TESTPMD_TX_OFFLOAD...). */
 219         uint16_t                tso_segsz;  /**< Segmentation offload MSS for non-tunneled packets. */
 220         uint16_t                tunnel_tso_segsz; /**< Segmentation offload MSS for tunneled pkts. */
 221         uint16_t                tx_vlan_id;/**< The tag ID */
 222         uint16_t                tx_vlan_id_outer;/**< The outer tag ID */
 223         void                    *fwd_ctx;   /**< Forwarding mode context */
 224         uint64_t                rx_bad_ip_csum; /**< rx pkts with bad ip checksum  */
 225         uint64_t                rx_bad_l4_csum; /**< rx pkts with bad l4 checksum */
 226         uint8_t                 tx_queue_stats_mapping_enabled;
 227         uint8_t                 rx_queue_stats_mapping_enabled;
 228         volatile uint16_t        port_status;    /**< port started or not */
 229         uint8_t                 need_reconfig;  /**< need reconfiguring port or not */
 230         uint8_t                 need_reconfig_queues; /**< need reconfiguring queues or not */
 231         uint8_t                 rss_flag;   /**< enable rss or not */
 232         uint8_t                 dcb_flag;   /**< enable dcb */
 233         struct rte_eth_rxconf   rx_conf;    /**< rx configuration */
 234         struct rte_eth_txconf   tx_conf;    /**< tx configuration */
 235         struct ether_addr       *mc_addr_pool; /**< pool of multicast addrs */
 236         uint32_t                mc_addr_nb; /**< nb. of addr. in mc_addr_pool */
 237         uint8_t                 slave_flag; /**< bonding slave port */
 238         struct port_flow        *flow_list; /**< Associated flows. */
 239 #ifdef TM_MODE
 240         unsigned int                    softnic_enable; /**< softnic flag */
 241         struct softnic_port     softport;  /**< softnic port params */
 242 #endif
 243 };
 244
 245 /**
 246  * The data structure associated with each forwarding logical core.
 247  * The logical cores are internally numbered by a core index from 0 to
 248  * the maximum number of logical cores - 1.
 249  * The system CPU identifier of all logical cores are setup in a global
 250  * CPU id. configuration table.
 251  */
 252 struct fwd_lcore {
 253         struct rte_gso_ctx gso_ctx;     /**< GSO context */
 254         struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
 255         void *gro_ctx;          /**< GRO context */
 256         streamid_t stream_idx;   /**< index of 1st stream in "fwd_streams" */
 257         streamid_t stream_nb;    /**< number of streams in "fwd_streams" */
 258         lcoreid_t  cpuid_idx;    /**< index of logical core in CPU id table */
 259         queueid_t  tx_queue;     /**< TX queue to send forwarded packets */
 260         volatile char stopped;   /**< stop forwarding when set */
 261 };
 262
 263 /*
 264  * Forwarding mode operations:
 265  *   - IO forwarding mode (default mode)
 266  *     Forwards packets unchanged.
 267  *
 268  *   - MAC forwarding mode
 269  *     Set the source and the destination Ethernet addresses of packets
 270  *     before forwarding them.
 271  *
 272  *   - IEEE1588 forwarding mode
 273  *     Check that received IEEE1588 Precise Time Protocol (PTP) packets are
 274  *     filtered and timestamped by the hardware.
 275  *     Forwards packets unchanged on the same port.
 276  *     Check that sent IEEE1588 PTP packets are timestamped by the hardware.
 277  */
 278 typedef void (*port_fwd_begin_t)(portid_t pi);
 279 typedef void (*port_fwd_end_t)(portid_t pi);
 280 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
 281
 282 struct fwd_engine {
 283         const char       *fwd_mode_name; /**< Forwarding mode name. */
 284         port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
 285         port_fwd_end_t   port_fwd_end;   /**< NULL if nothing special to do. */
 286         packet_fwd_t     packet_fwd;     /**< Mandatory. */
 287 };
 288
 289 #define BURST_TX_WAIT_US 1
 290 #define BURST_TX_RETRIES 64
 291
 292 extern uint32_t burst_tx_delay_time;
 293 extern uint32_t burst_tx_retry_num;
 294
 295 extern struct fwd_engine io_fwd_engine;
 296 extern struct fwd_engine mac_fwd_engine;
 297 extern struct fwd_engine mac_swap_engine;
 298 extern struct fwd_engine flow_gen_engine;
 299 extern struct fwd_engine rx_only_engine;
 300 extern struct fwd_engine tx_only_engine;
 301 extern struct fwd_engine csum_fwd_engine;
 302 extern struct fwd_engine icmp_echo_engine;
 303 #ifdef TM_MODE
 304 extern struct fwd_engine softnic_tm_engine;
 305 extern struct fwd_engine softnic_tm_bypass_engine;
 306 #endif
 307 #ifdef RTE_LIBRTE_IEEE1588
 308 extern struct fwd_engine ieee1588_fwd_engine;
 309 #endif
 310
 311 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
 312
 313 /**
 314  * Forwarding Configuration
 315  *
 316  */
 317 struct fwd_config {
 318         struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
 319         streamid_t nb_fwd_streams;  /**< Nb. of forward streams to process. */
 320         lcoreid_t  nb_fwd_lcores;   /**< Nb. of logical cores to launch. */
 321         portid_t   nb_fwd_ports;    /**< Nb. of ports involved. */
 322 };
 323
 324 /**
 325  * DCB mode enable
 326  */
 327 enum dcb_mode_enable
 328 {
 329         DCB_VT_ENABLED,
 330         DCB_ENABLED
 331 };
 332
 333 #define MAX_TX_QUEUE_STATS_MAPPINGS 1024 /* MAX_PORT of 32 @ 32 tx_queues/port */
 334 #define MAX_RX_QUEUE_STATS_MAPPINGS 4096 /* MAX_PORT of 32 @ 128 rx_queues/port */
 335
 336 struct queue_stats_mappings {
 337         portid_t port_id;
 338         uint16_t queue_id;
 339         uint8_t stats_counter_id;
 340 } __rte_cache_aligned;
 341
 342 extern struct queue_stats_mappings tx_queue_stats_mappings_array[];
 343 extern struct queue_stats_mappings rx_queue_stats_mappings_array[];
 344
 345 /* Assign both tx and rx queue stats mappings to the same default values */
 346 extern struct queue_stats_mappings *tx_queue_stats_mappings;
 347 extern struct queue_stats_mappings *rx_queue_stats_mappings;
 348
 349 extern uint16_t nb_tx_queue_stats_mappings;
 350 extern uint16_t nb_rx_queue_stats_mappings;
 351
 352 extern uint8_t xstats_hide_zero; /**< Hide zero values for xstats display */
 353
 354 /* globals used for configuration */
 355 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
 356 extern uint8_t  interactive;
 357 extern uint8_t  auto_start;
 358 extern uint8_t  tx_first;
 359 extern char cmdline_filename[PATH_MAX]; /**< offline commands file */
 360 extern uint8_t  numa_support; /**< set by "--numa" parameter */
 361 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
 362 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
 363 extern uint8_t flow_isolate_all; /**< set by "--flow-isolate-all */
 364 extern uint8_t  mp_anon; /**< set by "--mp-anon" parameter */
 365 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
 366 extern volatile int test_done; /* stop packet forwarding when set to 1. */
 367 extern uint8_t lsc_interrupt; /**< disabled by "--no-lsc-interrupt" parameter */
 368 extern uint8_t rmv_interrupt; /**< disabled by "--no-rmv-interrupt" parameter */
 369 extern uint32_t event_print_mask;
 370 /**< set by "--print-event xxxx" and "--mask-event xxxx parameters */
 371
 372 #ifdef RTE_LIBRTE_IXGBE_BYPASS
 373 extern uint32_t bypass_timeout; /**< Store the NIC bypass watchdog timeout */
 374 #endif
 375
 376 /*
 377  * Store specified sockets on which memory pool to be used by ports
 378  * is allocated.
 379  */
 380 uint8_t port_numa[RTE_MAX_ETHPORTS];
 381
 382 /*
 383  * Store specified sockets on which RX ring to be used by ports
 384  * is allocated.
 385  */
 386 uint8_t rxring_numa[RTE_MAX_ETHPORTS];
 387
 388 /*
 389  * Store specified sockets on which TX ring to be used by ports
 390  * is allocated.
 391  */
 392 uint8_t txring_numa[RTE_MAX_ETHPORTS];
 393
 394 extern uint8_t socket_num;
 395
 396 /*
 397  * Configuration of logical cores:
 398  * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
 399  */
 400 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
 401 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
 402 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
 403 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
 404 extern unsigned int num_sockets;
 405 extern unsigned int socket_ids[RTE_MAX_NUMA_NODES];
 406
 407 /*
 408  * Configuration of Ethernet ports:
 409  * nb_fwd_ports <= nb_cfg_ports <= nb_ports
 410  */
 411 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
 412 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
 413 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
 414 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
 415 extern struct rte_port *ports;
 416
 417 extern struct rte_eth_rxmode rx_mode;
 418 extern uint64_t rss_hf;
 419
 420 extern queueid_t nb_rxq;
 421 extern queueid_t nb_txq;
 422
 423 extern uint16_t nb_rxd;
 424 extern uint16_t nb_txd;
 425
 426 extern int16_t rx_free_thresh;
 427 extern int8_t rx_drop_en;
 428 extern int16_t tx_free_thresh;
 429 extern int16_t tx_rs_thresh;
 430 extern int32_t txq_flags;
 431
 432 extern uint8_t dcb_config;
 433 extern uint8_t dcb_test;
 434 extern enum dcb_queue_mapping_mode dcb_q_mapping;
 435
 436 extern uint16_t mbuf_data_size; /**< Mbuf data space size. */
 437 extern uint32_t param_total_num_mbufs;
 438
 439 extern uint16_t stats_period;
 440
 441 #ifdef RTE_LIBRTE_LATENCY_STATS
 442 extern uint8_t latencystats_enabled;
 443 extern lcoreid_t latencystats_lcore_id;
 444 #endif
 445
 446 #ifdef RTE_LIBRTE_BITRATE
 447 extern lcoreid_t bitrate_lcore_id;
 448 extern uint8_t bitrate_enabled;
 449 #endif
 450
 451 extern struct rte_fdir_conf fdir_conf;
 452
 453 /*
 454  * Configuration of packet segments used by the "txonly" processing engine.
 455  */
 456 #define TXONLY_DEF_PACKET_LEN 64
 457 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
 458 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
 459 extern uint8_t  tx_pkt_nb_segs; /**< Number of segments in TX packets */
 460
 461 enum tx_pkt_split {
 462         TX_PKT_SPLIT_OFF,
 463         TX_PKT_SPLIT_ON,
 464         TX_PKT_SPLIT_RND,
 465 };
 466
 467 extern enum tx_pkt_split tx_pkt_split;
 468
 469 extern uint16_t nb_pkt_per_burst;
 470 extern uint16_t mb_mempool_cache;
 471 extern int8_t rx_pthresh;
 472 extern int8_t rx_hthresh;
 473 extern int8_t rx_wthresh;
 474 extern int8_t tx_pthresh;
 475 extern int8_t tx_hthresh;
 476 extern int8_t tx_wthresh;
 477
 478 extern struct fwd_config cur_fwd_config;
 479 extern struct fwd_engine *cur_fwd_eng;
 480 extern uint32_t retry_enabled;
 481 extern struct fwd_lcore  **fwd_lcores;
 482 extern struct fwd_stream **fwd_streams;
 483
 484 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
 485 extern struct ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
 486
 487 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
 488 extern uint32_t burst_tx_retry_num;  /**< Burst tx retry number for mac-retry. */
 489
 490 #define GRO_DEFAULT_ITEM_NUM_PER_FLOW 32
 491 #define GRO_DEFAULT_FLOW_NUM (RTE_GRO_MAX_BURST_ITEM_NUM / \
 492                 GRO_DEFAULT_ITEM_NUM_PER_FLOW)
 493
 494 #define GRO_DEFAULT_FLUSH_CYCLES 1
 495 #define GRO_MAX_FLUSH_CYCLES 4
 496
 497 struct gro_status {
 498         struct rte_gro_param param;
 499         uint8_t enable;
 500 };
 501 extern struct gro_status gro_ports[RTE_MAX_ETHPORTS];
 502 extern uint8_t gro_flush_cycles;
 503
 504 #define GSO_MAX_PKT_BURST 2048
 505 struct gso_status {
 506         uint8_t enable;
 507 };
 508 extern struct gso_status gso_ports[RTE_MAX_ETHPORTS];
 509 extern uint16_t gso_max_segment_size;
 510
 511 static inline unsigned int
 512 lcore_num(void)
 513 {
 514         unsigned int i;
 515
 516         for (i = 0; i < RTE_MAX_LCORE; ++i)
 517                 if (fwd_lcores_cpuids[i] == rte_lcore_id())
 518                         return i;
 519
 520         rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
 521 }
 522
 523 static inline struct fwd_lcore *
 524 current_fwd_lcore(void)
 525 {
 526         return fwd_lcores[lcore_num()];
 527 }
 528
 529 /* Mbuf Pools */
 530 static inline void
 531 mbuf_poolname_build(unsigned int sock_id, char* mp_name, int name_size)
 532 {
 533         snprintf(mp_name, name_size, "mbuf_pool_socket_%u", sock_id);
 534 }
 535
 536 static inline struct rte_mempool *
 537 mbuf_pool_find(unsigned int sock_id)
 538 {
 539         char pool_name[RTE_MEMPOOL_NAMESIZE];
 540
 541         mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name));
 542         return rte_mempool_lookup((const char *)pool_name);
 543 }
 544
 545 /**
 546  * Read/Write operations on a PCI register of a port.
 547  */
 548 static inline uint32_t
 549 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
 550 {
 551         void *reg_addr;
 552         uint32_t reg_v;
 553
 554         reg_addr = (void *)
 555                 ((char *)port->dev_info.pci_dev->mem_resource[0].addr +
 556                         reg_off);
 557         reg_v = *((volatile uint32_t *)reg_addr);
 558         return rte_le_to_cpu_32(reg_v);
 559 }
 560
 561 #define port_id_pci_reg_read(pt_id, reg_off) \
 562         port_pci_reg_read(&ports[(pt_id)], (reg_off))
 563
 564 static inline void
 565 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
 566 {
 567         void *reg_addr;
 568
 569         reg_addr = (void *)
 570                 ((char *)port->dev_info.pci_dev->mem_resource[0].addr +
 571                         reg_off);
 572         *((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
 573 }
 574
 575 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
 576         port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
 577
 578 /* Prototypes */
 579 unsigned int parse_item_list(char* str, const char* item_name,
 580                         unsigned int max_items,
 581                         unsigned int *parsed_items, int check_unique_values);
 582 void launch_args_parse(int argc, char** argv);
 583 void cmdline_read_from_file(const char *filename);
 584 void prompt(void);
 585 void prompt_exit(void);
 586 void nic_stats_display(portid_t port_id);
 587 void nic_stats_clear(portid_t port_id);
 588 void nic_xstats_display(portid_t port_id);
 589 void nic_xstats_clear(portid_t port_id);
 590 void nic_stats_mapping_display(portid_t port_id);
 591 void port_infos_display(portid_t port_id);
 592 void port_offload_cap_display(portid_t port_id);
 593 void rx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
 594 void tx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
 595 void fwd_lcores_config_display(void);
 596 void pkt_fwd_config_display(struct fwd_config *cfg);
 597 void rxtx_config_display(void);
 598 void fwd_config_setup(void);
 599 void set_def_fwd_config(void);
 600 void reconfig(portid_t new_port_id, unsigned socket_id);
 601 int init_fwd_streams(void);
 602
 603 void port_mtu_set(portid_t port_id, uint16_t mtu);
 604 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
 605 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
 606                       uint8_t bit_v);
 607 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
 608                                 uint8_t bit1_pos, uint8_t bit2_pos);
 609 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
 610                             uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
 611 void port_reg_display(portid_t port_id, uint32_t reg_off);
 612 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
 613 int port_flow_validate(portid_t port_id,
 614                        const struct rte_flow_attr *attr,
 615                        const struct rte_flow_item *pattern,
 616                        const struct rte_flow_action *actions);
 617 int port_flow_create(portid_t port_id,
 618                      const struct rte_flow_attr *attr,
 619                      const struct rte_flow_item *pattern,
 620                      const struct rte_flow_action *actions);
 621 int port_flow_destroy(portid_t port_id, uint32_t n, const uint32_t *rule);
 622 int port_flow_flush(portid_t port_id);
 623 int port_flow_query(portid_t port_id, uint32_t rule,
 624                     enum rte_flow_action_type action);
 625 void port_flow_list(portid_t port_id, uint32_t n, const uint32_t *group);
 626 int port_flow_isolate(portid_t port_id, int set);
 627
 628 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
 629 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
 630
 631 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
 632 int set_fwd_lcores_mask(uint64_t lcoremask);
 633 void set_fwd_lcores_number(uint16_t nb_lc);
 634
 635 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
 636 void set_fwd_ports_mask(uint64_t portmask);
 637 void set_fwd_ports_number(uint16_t nb_pt);
 638 int port_is_forwarding(portid_t port_id);
 639
 640 void rx_vlan_strip_set(portid_t port_id, int on);
 641 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
 642
 643 void rx_vlan_filter_set(portid_t port_id, int on);
 644 void rx_vlan_all_filter_set(portid_t port_id, int on);
 645 int rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
 646 void vlan_extend_set(portid_t port_id, int on);
 647 void vlan_tpid_set(portid_t port_id, enum rte_vlan_type vlan_type,
 648                    uint16_t tp_id);
 649 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
 650 void tx_qinq_set(portid_t port_id, uint16_t vlan_id, uint16_t vlan_id_outer);
 651 void tx_vlan_reset(portid_t port_id);
 652 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
 653
 654 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
 655
 656 void set_xstats_hide_zero(uint8_t on_off);
 657
 658 void set_verbose_level(uint16_t vb_level);
 659 void set_tx_pkt_segments(unsigned *seg_lengths, unsigned nb_segs);
 660 void show_tx_pkt_segments(void);
 661 void set_tx_pkt_split(const char *name);
 662 void set_nb_pkt_per_burst(uint16_t pkt_burst);
 663 char *list_pkt_forwarding_modes(void);
 664 char *list_pkt_forwarding_retry_modes(void);
 665 void set_pkt_forwarding_mode(const char *fwd_mode);
 666 void start_packet_forwarding(int with_tx_first);
 667 void stop_packet_forwarding(void);
 668 void dev_set_link_up(portid_t pid);
 669 void dev_set_link_down(portid_t pid);
 670 void init_port_config(void);
 671 void set_port_slave_flag(portid_t slave_pid);
 672 void clear_port_slave_flag(portid_t slave_pid);
 673 uint8_t port_is_bonding_slave(portid_t slave_pid);
 674
 675 int init_port_dcb_config(portid_t pid, enum dcb_mode_enable dcb_mode,
 676                      enum rte_eth_nb_tcs num_tcs,
 677                      uint8_t pfc_en);
 678 int start_port(portid_t pid);
 679 void stop_port(portid_t pid);
 680 void close_port(portid_t pid);
 681 void reset_port(portid_t pid);
 682 void attach_port(char *identifier);
 683 void detach_port(portid_t port_id);
 684 int all_ports_stopped(void);
 685 int port_is_started(portid_t port_id);
 686 void pmd_test_exit(void);
 687 void fdir_get_infos(portid_t port_id);
 688 void fdir_set_flex_mask(portid_t port_id,
 689                            struct rte_eth_fdir_flex_mask *cfg);
 690 void fdir_set_flex_payload(portid_t port_id,
 691                            struct rte_eth_flex_payload_cfg *cfg);
 692 void port_rss_reta_info(portid_t port_id,
 693                         struct rte_eth_rss_reta_entry64 *reta_conf,
 694                         uint16_t nb_entries);
 695
 696 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
 697
 698 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
 699 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
 700                                 uint64_t q_msk);
 701
 702 void port_rss_hash_conf_show(portid_t port_id, char rss_info[],
 703                              int show_rss_key);
 704 void port_rss_hash_key_update(portid_t port_id, char rss_type[],
 705                               uint8_t *hash_key, uint hash_key_len);
 706 int rx_queue_id_is_invalid(queueid_t rxq_id);
 707 int tx_queue_id_is_invalid(queueid_t txq_id);
 708 void setup_gro(const char *onoff, portid_t port_id);
 709 void setup_gro_flush_cycles(uint8_t cycles);
 710 void show_gro(portid_t port_id);
 711 void setup_gso(const char *mode, portid_t port_id);
 712
 713 /* Functions to manage the set of filtered Multicast MAC addresses */
 714 void mcast_addr_add(portid_t port_id, struct ether_addr *mc_addr);
 715 void mcast_addr_remove(portid_t port_id, struct ether_addr *mc_addr);
 716 void port_dcb_info_display(portid_t port_id);
 717
 718 uint8_t *open_ddp_package_file(const char *file_path, uint32_t *size);
 719 int save_ddp_package_file(const char *file_path, uint8_t *buf, uint32_t size);
 720 int close_ddp_package_file(uint8_t *buf);
 721
 722 void port_queue_region_info_display(portid_t port_id, void *buf);
 723
 724 enum print_warning {
 725         ENABLED_WARN = 0,
 726         DISABLED_WARN
 727 };
 728 int port_id_is_invalid(portid_t port_id, enum print_warning warning);
 729 int new_socket_id(unsigned int socket_id);
 730
 731 queueid_t get_allowed_max_nb_rxq(portid_t *pid);
 732 int check_nb_rxq(queueid_t rxq);
 733 queueid_t get_allowed_max_nb_txq(portid_t *pid);
 734 int check_nb_txq(queueid_t txq);
 735
 736 /*
 737  * Work-around of a compilation error with ICC on invocations of the
 738  * rte_be_to_cpu_16() function.
 739  */
 740 #ifdef __GCC__
 741 #define RTE_BE_TO_CPU_16(be_16_v)  rte_be_to_cpu_16((be_16_v))
 742 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
 743 #else
 744 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
 745 #define RTE_BE_TO_CPU_16(be_16_v)  (be_16_v)
 746 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
 747 #else
 748 #define RTE_BE_TO_CPU_16(be_16_v) \
 749         (uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
 750 #define RTE_CPU_TO_BE_16(cpu_16_v) \
 751         (uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
 752 #endif
 753 #endif /* __GCC__ */
 754
 755 #endif /* _TESTPMD_H_ */