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