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