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