app/test-pmd/testpmd.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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
  35 #ifndef _TESTPMD_H_
  36 #define _TESTPMD_H_
  37
  38 /* icc on baremetal gives us troubles with function named 'main' */
  39 #ifdef RTE_EXEC_ENV_BAREMETAL
  40 #define main _main
  41 int main(int argc, char **argv);
  42 #endif
  43
  44 #define RTE_PORT_ALL            (~(portid_t)0x0)
  45
  46 #define RTE_TEST_RX_DESC_MAX    2048
  47 #define RTE_TEST_TX_DESC_MAX    2048
  48
  49 #define RTE_PORT_STOPPED        (uint16_t)0
  50 #define RTE_PORT_STARTED        (uint16_t)1
  51 #define RTE_PORT_CLOSED         (uint16_t)2
  52 #define RTE_PORT_HANDLING       (uint16_t)3
  53
  54 /*
  55  * Default size of the mbuf data buffer to receive standard 1518-byte
  56  * Ethernet frames in a mono-segment memory buffer.
  57  */
  58 #define DEFAULT_MBUF_DATA_SIZE 2048 /**< 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 /**< pkt.nb_segs is a 8-bit unsigned char. */
  65
  66 #define MAX_PKT_BURST 512
  67 #define DEF_PKT_BURST 16
  68
  69 #define CACHE_LINE_SIZE_ROUNDUP(size) \
  70         (CACHE_LINE_SIZE * ((size + CACHE_LINE_SIZE - 1) / CACHE_LINE_SIZE))
  71
  72 typedef uint8_t  lcoreid_t;
  73 typedef uint8_t  portid_t;
  74 typedef uint16_t queueid_t;
  75 typedef uint16_t streamid_t;
  76
  77 #define MAX_QUEUE_ID ((1 << (sizeof(queueid_t) * 8)) - 1)
  78
  79 enum {
  80         PORT_TOPOLOGY_PAIRED,
  81         PORT_TOPOLOGY_CHAINED
  82 };
  83
  84 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
  85 /**
  86  * The data structure associated with RX and TX packet burst statistics
  87  * that are recorded for each forwarding stream.
  88  */
  89 struct pkt_burst_stats {
  90         unsigned int pkt_burst_spread[MAX_PKT_BURST];
  91 };
  92 #endif
  93
  94 /**
  95  * The data structure associated with a forwarding stream between a receive
  96  * port/queue and a transmit port/queue.
  97  */
  98 struct fwd_stream {
  99         /* "read-only" data */
 100         portid_t   rx_port;   /**< port to poll for received packets */
 101         queueid_t  rx_queue;  /**< RX queue to poll on "rx_port" */
 102         portid_t   tx_port;   /**< forwarding port of received packets */
 103         queueid_t  tx_queue;  /**< TX queue to send forwarded packets */
 104         streamid_t peer_addr; /**< index of peer ethernet address of packets */
 105
 106         /* "read-write" results */
 107         unsigned int rx_packets;  /**< received packets */
 108         unsigned int tx_packets;  /**< received packets transmitted */
 109         unsigned int fwd_dropped; /**< received packets not forwarded */
 110         unsigned int rx_bad_ip_csum ; /**< received packets has bad ip checksum */
 111         unsigned int rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
 112 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
 113         uint64_t     core_cycles; /**< used for RX and TX processing */
 114 #endif
 115 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
 116         struct pkt_burst_stats rx_burst_stats;
 117         struct pkt_burst_stats tx_burst_stats;
 118 #endif
 119 };
 120
 121 /**
 122  * The data structure associated with each port.
 123  * tx_ol_flags is slightly different from ol_flags of rte_mbuf.
 124  *       Bit  0: Insert IP checksum
 125  *   Bit  1: Insert UDP checksum
 126  *   Bit  2: Insert TCP checksum
 127  *   Bit  3: Insert SCTP checksum
 128  *   Bit 11: Insert VLAN Label
 129  */
 130 struct rte_port {
 131         struct rte_eth_dev_info dev_info;   /**< PCI info + driver name */
 132         struct rte_eth_conf     dev_conf;   /**< Port configuration. */
 133         struct ether_addr       eth_addr;   /**< Port ethernet address */
 134         struct rte_eth_stats    stats;      /**< Last port statistics */
 135         uint64_t                tx_dropped; /**< If no descriptor in TX ring */
 136         struct fwd_stream       *rx_stream; /**< Port RX stream, if unique */
 137         struct fwd_stream       *tx_stream; /**< Port TX stream, if unique */
 138         unsigned int            socket_id;  /**< For NUMA support */
 139         uint16_t                tx_ol_flags;/**< Offload Flags of TX packets. */
 140         uint16_t                tx_vlan_id; /**< Tag Id. in TX VLAN packets. */
 141         void                    *fwd_ctx;   /**< Forwarding mode context */
 142         uint64_t                rx_bad_ip_csum; /**< rx pkts with bad ip checksum  */
 143         uint64_t                rx_bad_l4_csum; /**< rx pkts with bad l4 checksum */
 144         uint8_t                 tx_queue_stats_mapping_enabled;
 145         uint8_t                 rx_queue_stats_mapping_enabled;
 146         volatile uint16_t        port_status;    /**< port started or not */
 147         uint8_t                 need_reconfig;  /**< need reconfiguring port or not */
 148         uint8_t                 need_reconfig_queues; /**< need reconfiguring queues or not */
 149         uint8_t                 rss_flag;   /**< enable rss or not */
 150         struct rte_eth_rxconf   rx_conf;    /**< rx configuration */
 151         struct rte_eth_txconf   tx_conf;    /**< tx configuration */
 152 };
 153
 154 /**
 155  * The data structure associated with each forwarding logical core.
 156  * The logical cores are internally numbered by a core index from 0 to
 157  * the maximum number of logical cores - 1.
 158  * The system CPU identifier of all logical cores are setup in a global
 159  * CPU id. configuration table.
 160  */
 161 struct fwd_lcore {
 162         struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
 163         streamid_t stream_idx;   /**< index of 1st stream in "fwd_streams" */
 164         streamid_t stream_nb;    /**< number of streams in "fwd_streams" */
 165         lcoreid_t  cpuid_idx;    /**< index of logical core in CPU id table */
 166         queueid_t  tx_queue;     /**< TX queue to send forwarded packets */
 167         volatile char stopped;   /**< stop forwarding when set */
 168 };
 169
 170 /*
 171  * Forwarding mode operations:
 172  *   - IO forwarding mode (default mode)
 173  *     Forwards packets unchanged.
 174  *
 175  *   - MAC forwarding mode
 176  *     Set the source and the destination Ethernet addresses of packets
 177  *     before forwarding them.
 178  *
 179  *   - IEEE1588 forwarding mode
 180  *     Check that received IEEE1588 Precise Time Protocol (PTP) packets are
 181  *     filtered and timestamped by the hardware.
 182  *     Forwards packets unchanged on the same port.
 183  *     Check that sent IEEE1588 PTP packets are timestamped by the hardware.
 184  */
 185 typedef void (*port_fwd_begin_t)(portid_t pi);
 186 typedef void (*port_fwd_end_t)(portid_t pi);
 187 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
 188
 189 struct fwd_engine {
 190         const char       *fwd_mode_name; /**< Forwarding mode name. */
 191         port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
 192         port_fwd_end_t   port_fwd_end;   /**< NULL if nothing special to do. */
 193         packet_fwd_t     packet_fwd;     /**< Mandatory. */
 194 };
 195
 196 extern struct fwd_engine io_fwd_engine;
 197 extern struct fwd_engine mac_fwd_engine;
 198 extern struct fwd_engine rx_only_engine;
 199 extern struct fwd_engine tx_only_engine;
 200 extern struct fwd_engine csum_fwd_engine;
 201 #ifdef RTE_LIBRTE_IEEE1588
 202 extern struct fwd_engine ieee1588_fwd_engine;
 203 #endif
 204
 205 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
 206
 207 /**
 208  * Forwarding Configuration
 209  *
 210  */
 211 struct fwd_config {
 212         struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
 213         streamid_t nb_fwd_streams;  /**< Nb. of forward streams to process. */
 214         lcoreid_t  nb_fwd_lcores;   /**< Nb. of logical cores to launch. */
 215         portid_t   nb_fwd_ports;    /**< Nb. of ports involved. */
 216 };
 217
 218 #define MAX_TX_QUEUE_STATS_MAPPINGS 1024 /* MAX_PORT of 32 @ 32 tx_queues/port */
 219 #define MAX_RX_QUEUE_STATS_MAPPINGS 4096 /* MAX_PORT of 32 @ 128 rx_queues/port */
 220
 221 struct queue_stats_mappings {
 222         uint8_t port_id;
 223         uint16_t queue_id;
 224         uint8_t stats_counter_id;
 225 } __rte_cache_aligned;
 226
 227 extern struct queue_stats_mappings tx_queue_stats_mappings_array[];
 228 extern struct queue_stats_mappings rx_queue_stats_mappings_array[];
 229
 230 /* Assign both tx and rx queue stats mappings to the same default values */
 231 extern struct queue_stats_mappings *tx_queue_stats_mappings;
 232 extern struct queue_stats_mappings *rx_queue_stats_mappings;
 233
 234 extern uint16_t nb_tx_queue_stats_mappings;
 235 extern uint16_t nb_rx_queue_stats_mappings;
 236
 237 /* globals used for configuration */
 238 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
 239 extern uint8_t  interactive;
 240 extern uint8_t  numa_support; /**< set by "--numa" parameter */
 241 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
 242
 243 /*
 244  * Configuration of logical cores:
 245  * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
 246  */
 247 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
 248 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
 249 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
 250 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
 251
 252 /*
 253  * Configuration of Ethernet ports:
 254  * nb_fwd_ports <= nb_cfg_ports <= nb_ports
 255  */
 256 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
 257 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
 258 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
 259 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
 260 extern struct rte_port *ports;
 261
 262 extern struct rte_eth_rxmode rx_mode;
 263 extern uint16_t rss_hf;
 264
 265 extern queueid_t nb_rxq;
 266 extern queueid_t nb_txq;
 267
 268 extern uint16_t nb_rxd;
 269 extern uint16_t nb_txd;
 270
 271 extern uint16_t rx_free_thresh;
 272 extern uint8_t rx_drop_en;
 273 extern uint16_t tx_free_thresh;
 274 extern uint16_t tx_rs_thresh;
 275 extern uint32_t txq_flags;
 276
 277 extern uint16_t mbuf_data_size; /**< Mbuf data space size. */
 278 extern uint32_t param_total_num_mbufs;
 279
 280 extern struct rte_fdir_conf fdir_conf;
 281
 282 /*
 283  * Configuration of packet segments used by the "txonly" processing engine.
 284  */
 285 #define TXONLY_DEF_PACKET_LEN 64
 286 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
 287 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
 288 extern uint8_t  tx_pkt_nb_segs; /**< Number of segments in TX packets */
 289
 290 extern uint16_t nb_pkt_per_burst;
 291 extern uint16_t mb_mempool_cache;
 292 extern struct rte_eth_thresh rx_thresh;
 293 extern struct rte_eth_thresh tx_thresh;
 294
 295 extern struct fwd_config cur_fwd_config;
 296 extern struct fwd_engine *cur_fwd_eng;
 297 extern struct fwd_lcore  **fwd_lcores;
 298 extern struct fwd_stream **fwd_streams;
 299
 300 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
 301 extern struct ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
 302
 303 static inline unsigned int
 304 lcore_num(void)
 305 {
 306         unsigned int i;
 307
 308         for (i = 0; i < RTE_MAX_LCORE; ++i)
 309                 if (fwd_lcores_cpuids[i] == rte_lcore_id())
 310                         return i;
 311
 312         rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
 313 }
 314
 315 static inline struct fwd_lcore *
 316 current_fwd_lcore(void)
 317 {
 318         return fwd_lcores[lcore_num()];
 319 }
 320
 321 /* Mbuf Pools */
 322 static inline void
 323 mbuf_poolname_build(unsigned int sock_id, char* mp_name, int name_size)
 324 {
 325         rte_snprintf(mp_name, name_size, "mbuf_pool_socket_%u", sock_id);
 326 }
 327
 328 static inline struct rte_mempool *
 329 mbuf_pool_find(unsigned int sock_id)
 330 {
 331         char pool_name[RTE_MEMPOOL_NAMESIZE];
 332
 333         mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name));
 334         return (rte_mempool_lookup((const char *)pool_name));
 335 }
 336
 337 /**
 338  * Read/Write operations on a PCI register of a port.
 339  */
 340 static inline uint32_t
 341 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
 342 {
 343         void *reg_addr;
 344         uint32_t reg_v;
 345
 346         reg_addr = (void *)((char *)port->dev_info.pci_dev->mem_resource.addr +
 347                             reg_off);
 348         reg_v = *((volatile uint32_t *)reg_addr);
 349         return rte_le_to_cpu_32(reg_v);
 350 }
 351
 352 #define port_id_pci_reg_read(pt_id, reg_off) \
 353         port_pci_reg_read(&ports[(pt_id)], (reg_off))
 354
 355 static inline void
 356 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
 357 {
 358         void *reg_addr;
 359
 360         reg_addr = (void *)((char *)port->dev_info.pci_dev->mem_resource.addr +
 361                             reg_off);
 362         *((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
 363 }
 364
 365 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
 366         port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
 367
 368 /* Prototypes */
 369 void launch_args_parse(int argc, char** argv);
 370 void prompt(void);
 371 void nic_stats_display(portid_t port_id);
 372 void nic_stats_clear(portid_t port_id);
 373 void nic_stats_mapping_display(portid_t port_id);
 374 void port_infos_display(portid_t port_id);
 375 void fwd_lcores_config_display(void);
 376 void fwd_config_display(void);
 377 void rxtx_config_display(void);
 378 void fwd_config_setup(void);
 379 void set_def_fwd_config(void);
 380
 381 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
 382 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
 383                       uint8_t bit_v);
 384 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
 385                                 uint8_t bit1_pos, uint8_t bit2_pos);
 386 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
 387                             uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
 388 void port_reg_display(portid_t port_id, uint32_t reg_off);
 389 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
 390
 391 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
 392 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
 393
 394 void set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
 395 void set_fwd_lcores_mask(uint64_t lcoremask);
 396 void set_fwd_lcores_number(uint16_t nb_lc);
 397
 398 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
 399 void set_fwd_ports_mask(uint64_t portmask);
 400 void set_fwd_ports_number(uint16_t nb_pt);
 401
 402 void rx_vlan_strip_set(portid_t port_id, int on);
 403 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
 404
 405 void rx_vlan_filter_set(portid_t port_id, int on);
 406 void rx_vlan_all_filter_set(portid_t port_id, int on);
 407 void rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
 408 void vlan_extend_set(portid_t port_id, int on);
 409 void vlan_tpid_set(portid_t port_id, uint16_t tp_id);
 410 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
 411 void tx_vlan_reset(portid_t port_id);
 412
 413
 414 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
 415
 416 void tx_cksum_set(portid_t port_id, uint8_t cksum_mask);
 417
 418 void set_verbose_level(uint16_t vb_level);
 419 void set_tx_pkt_segments(unsigned *seg_lengths, unsigned nb_segs);
 420 void set_nb_pkt_per_burst(uint16_t pkt_burst);
 421 void set_pkt_forwarding_mode(const char *fwd_mode);
 422 void start_packet_forwarding(int with_tx_first);
 423 void stop_packet_forwarding(void);
 424 void init_port_config(void);
 425 void start_port(portid_t pid);
 426 void stop_port(portid_t pid);
 427 void close_port(portid_t pid);
 428 int all_ports_stopped(void);
 429 void pmd_test_exit(void);
 430
 431 void fdir_add_signature_filter(portid_t port_id, uint8_t queue_id,
 432                                struct rte_fdir_filter *fdir_filter);
 433 void fdir_update_signature_filter(portid_t port_id, uint8_t queue_id,
 434                                   struct rte_fdir_filter *fdir_filter);
 435 void fdir_remove_signature_filter(portid_t port_id,
 436                                   struct rte_fdir_filter *fdir_filter);
 437 void fdir_get_infos(portid_t port_id);
 438 void fdir_add_perfect_filter(portid_t port_id, uint16_t soft_id,
 439                              uint8_t queue_id, uint8_t drop,
 440                              struct rte_fdir_filter *fdir_filter);
 441 void fdir_update_perfect_filter(portid_t port_id, uint16_t soft_id,
 442                                 uint8_t queue_id, uint8_t drop,
 443                                 struct rte_fdir_filter *fdir_filter);
 444 void fdir_remove_perfect_filter(portid_t port_id, uint16_t soft_id,
 445                                 struct rte_fdir_filter *fdir_filter);
 446 void fdir_set_masks(portid_t port_id, struct rte_fdir_masks *fdir_masks);
 447
 448 /*
 449  * Work-around of a compilation error with ICC on invocations of the
 450  * rte_be_to_cpu_16() function.
 451  */
 452 #ifdef __GCC__
 453 #define RTE_BE_TO_CPU_16(be_16_v)  rte_be_to_cpu_16((be_16_v))
 454 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
 455 #else
 456 #ifdef __big_endian__
 457 #define RTE_BE_TO_CPU_16(be_16_v)  (be_16_v)
 458 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
 459 #else
 460 #define RTE_BE_TO_CPU_16(be_16_v) \
 461         (uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
 462 #define RTE_CPU_TO_BE_16(cpu_16_v) \
 463         (uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
 464 #endif
 465 #endif /* __GCC__ */
 466
 467 #endif /* _TESTPMD_H_ */