app/test-pmd/testpmd.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2017 Intel Corporation
   3  */
   4
   5 #ifndef _TESTPMD_H_
   6 #define _TESTPMD_H_
   7
   8 #include <stdbool.h>
   9
  10 #include <rte_pci.h>
  11 #include <rte_bus_pci.h>
  12 #include <rte_gro.h>
  13 #include <rte_gso.h>
  14 #include <cmdline.h>
  15
  16 #define RTE_PORT_ALL            (~(portid_t)0x0)
  17
  18 #define RTE_TEST_RX_DESC_MAX    2048
  19 #define RTE_TEST_TX_DESC_MAX    2048
  20
  21 #define RTE_PORT_STOPPED        (uint16_t)0
  22 #define RTE_PORT_STARTED        (uint16_t)1
  23 #define RTE_PORT_CLOSED         (uint16_t)2
  24 #define RTE_PORT_HANDLING       (uint16_t)3
  25
  26 /*
  27  * It is used to allocate the memory for hash key.
  28  * The hash key size is NIC dependent.
  29  */
  30 #define RSS_HASH_KEY_LENGTH 64
  31
  32 /*
  33  * Default size of the mbuf data buffer to receive standard 1518-byte
  34  * Ethernet frames in a mono-segment memory buffer.
  35  */
  36 #define DEFAULT_MBUF_DATA_SIZE RTE_MBUF_DEFAULT_BUF_SIZE
  37 /**< Default size of mbuf data buffer. */
  38
  39 /*
  40  * The maximum number of segments per packet is used when creating
  41  * scattered transmit packets composed of a list of mbufs.
  42  */
  43 #define RTE_MAX_SEGS_PER_PKT 255 /**< nb_segs is a 8-bit unsigned char. */
  44
  45 #define MAX_PKT_BURST 512
  46 #define DEF_PKT_BURST 32
  47
  48 #define DEF_MBUF_CACHE 250
  49
  50 #define RTE_CACHE_LINE_SIZE_ROUNDUP(size) \
  51         (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
  52
  53 #define NUMA_NO_CONFIG 0xFF
  54 #define UMA_NO_CONFIG  0xFF
  55
  56 typedef uint8_t  lcoreid_t;
  57 typedef uint16_t portid_t;
  58 typedef uint16_t queueid_t;
  59 typedef uint16_t streamid_t;
  60
  61 enum {
  62         PORT_TOPOLOGY_PAIRED,
  63         PORT_TOPOLOGY_CHAINED,
  64         PORT_TOPOLOGY_LOOP,
  65 };
  66
  67 enum {
  68         MP_ALLOC_NATIVE, /**< allocate and populate mempool natively */
  69         MP_ALLOC_ANON,
  70         /**< allocate mempool natively, but populate using anonymous memory */
  71         MP_ALLOC_XMEM,
  72         /**< allocate and populate mempool using anonymous memory */
  73         MP_ALLOC_XMEM_HUGE,
  74         /**< allocate and populate mempool using anonymous hugepage memory */
  75         MP_ALLOC_XBUF
  76         /**< allocate mempool natively, use rte_pktmbuf_pool_create_extbuf */
  77 };
  78
  79 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
  80 /**
  81  * The data structure associated with RX and TX packet burst statistics
  82  * that are recorded for each forwarding stream.
  83  */
  84 struct pkt_burst_stats {
  85         unsigned int pkt_burst_spread[MAX_PKT_BURST];
  86 };
  87 #endif
  88
  89 /** Information for a given RSS type. */
  90 struct rss_type_info {
  91         const char *str; /**< Type name. */
  92         uint64_t rss_type; /**< Type value. */
  93 };
  94
  95 /**
  96  * RSS type information table.
  97  *
  98  * An entry with a NULL type name terminates the list.
  99  */
 100 extern const struct rss_type_info rss_type_table[];
 101
 102 /**
 103  * Dynf name array.
 104  *
 105  * Array that holds the name for each dynf.
 106  */
 107 extern char dynf_names[64][RTE_MBUF_DYN_NAMESIZE];
 108
 109 /**
 110  * The data structure associated with a forwarding stream between a receive
 111  * port/queue and a transmit port/queue.
 112  */
 113 struct fwd_stream {
 114         /* "read-only" data */
 115         portid_t   rx_port;   /**< port to poll for received packets */
 116         queueid_t  rx_queue;  /**< RX queue to poll on "rx_port" */
 117         portid_t   tx_port;   /**< forwarding port of received packets */
 118         queueid_t  tx_queue;  /**< TX queue to send forwarded packets */
 119         streamid_t peer_addr; /**< index of peer ethernet address of packets */
 120
 121         unsigned int retry_enabled;
 122
 123         /* "read-write" results */
 124         uint64_t rx_packets;  /**< received packets */
 125         uint64_t tx_packets;  /**< received packets transmitted */
 126         uint64_t fwd_dropped; /**< received packets not forwarded */
 127         uint64_t rx_bad_ip_csum ; /**< received packets has bad ip checksum */
 128         uint64_t rx_bad_l4_csum ; /**< received packets has bad l4 checksum */
 129         uint64_t rx_bad_outer_l4_csum;
 130         /**< received packets has bad outer l4 checksum */
 131         unsigned int gro_times; /**< GRO operation times */
 132 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
 133         uint64_t     core_cycles; /**< used for RX and TX processing */
 134 #endif
 135 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
 136         struct pkt_burst_stats rx_burst_stats;
 137         struct pkt_burst_stats tx_burst_stats;
 138 #endif
 139 };
 140
 141 /** Descriptor for a single flow. */
 142 struct port_flow {
 143         struct port_flow *next; /**< Next flow in list. */
 144         struct port_flow *tmp; /**< Temporary linking. */
 145         uint32_t id; /**< Flow rule ID. */
 146         struct rte_flow *flow; /**< Opaque flow object returned by PMD. */
 147         struct rte_flow_conv_rule rule; /* Saved flow rule description. */
 148         uint8_t data[]; /**< Storage for flow rule description */
 149 };
 150
 151 /**
 152  * The data structure associated with each port.
 153  */
 154 struct rte_port {
 155         struct rte_eth_dev_info dev_info;   /**< PCI info + driver name */
 156         struct rte_eth_conf     dev_conf;   /**< Port configuration. */
 157         struct rte_ether_addr       eth_addr;   /**< Port ethernet address */
 158         struct rte_eth_stats    stats;      /**< Last port statistics */
 159         unsigned int            socket_id;  /**< For NUMA support */
 160         uint16_t                parse_tunnel:1; /**< Parse internal headers */
 161         uint16_t                tso_segsz;  /**< Segmentation offload MSS for non-tunneled packets. */
 162         uint16_t                tunnel_tso_segsz; /**< Segmentation offload MSS for tunneled pkts. */
 163         uint16_t                tx_vlan_id;/**< The tag ID */
 164         uint16_t                tx_vlan_id_outer;/**< The outer tag ID */
 165         uint8_t                 tx_queue_stats_mapping_enabled;
 166         uint8_t                 rx_queue_stats_mapping_enabled;
 167         volatile uint16_t        port_status;    /**< port started or not */
 168         uint8_t                 need_setup;     /**< port just attached */
 169         uint8_t                 need_reconfig;  /**< need reconfiguring port or not */
 170         uint8_t                 need_reconfig_queues; /**< need reconfiguring queues or not */
 171         uint8_t                 rss_flag;   /**< enable rss or not */
 172         uint8_t                 dcb_flag;   /**< enable dcb */
 173         uint16_t                nb_rx_desc[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue rx desc number */
 174         uint16_t                nb_tx_desc[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue tx desc number */
 175         struct rte_eth_rxconf   rx_conf[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue rx configuration */
 176         struct rte_eth_txconf   tx_conf[RTE_MAX_QUEUES_PER_PORT+1]; /**< per queue tx configuration */
 177         struct rte_ether_addr   *mc_addr_pool; /**< pool of multicast addrs */
 178         uint32_t                mc_addr_nb; /**< nb. of addr. in mc_addr_pool */
 179         uint8_t                 slave_flag; /**< bonding slave port */
 180         struct port_flow        *flow_list; /**< Associated flows. */
 181         const struct rte_eth_rxtx_callback *rx_dump_cb[RTE_MAX_QUEUES_PER_PORT+1];
 182         const struct rte_eth_rxtx_callback *tx_dump_cb[RTE_MAX_QUEUES_PER_PORT+1];
 183         /**< metadata value to insert in Tx packets. */
 184         uint32_t                tx_metadata;
 185         const struct rte_eth_rxtx_callback *tx_set_md_cb[RTE_MAX_QUEUES_PER_PORT+1];
 186         /**< dynamic flags. */
 187         uint64_t                mbuf_dynf;
 188         const struct rte_eth_rxtx_callback *tx_set_dynf_cb[RTE_MAX_QUEUES_PER_PORT+1];
 189 };
 190
 191 /**
 192  * The data structure associated with each forwarding logical core.
 193  * The logical cores are internally numbered by a core index from 0 to
 194  * the maximum number of logical cores - 1.
 195  * The system CPU identifier of all logical cores are setup in a global
 196  * CPU id. configuration table.
 197  */
 198 struct fwd_lcore {
 199         struct rte_gso_ctx gso_ctx;     /**< GSO context */
 200         struct rte_mempool *mbp; /**< The mbuf pool to use by this core */
 201         void *gro_ctx;          /**< GRO context */
 202         streamid_t stream_idx;   /**< index of 1st stream in "fwd_streams" */
 203         streamid_t stream_nb;    /**< number of streams in "fwd_streams" */
 204         lcoreid_t  cpuid_idx;    /**< index of logical core in CPU id table */
 205         queueid_t  tx_queue;     /**< TX queue to send forwarded packets */
 206         volatile char stopped;   /**< stop forwarding when set */
 207 };
 208
 209 /*
 210  * Forwarding mode operations:
 211  *   - IO forwarding mode (default mode)
 212  *     Forwards packets unchanged.
 213  *
 214  *   - MAC forwarding mode
 215  *     Set the source and the destination Ethernet addresses of packets
 216  *     before forwarding them.
 217  *
 218  *   - IEEE1588 forwarding mode
 219  *     Check that received IEEE1588 Precise Time Protocol (PTP) packets are
 220  *     filtered and timestamped by the hardware.
 221  *     Forwards packets unchanged on the same port.
 222  *     Check that sent IEEE1588 PTP packets are timestamped by the hardware.
 223  */
 224 typedef void (*port_fwd_begin_t)(portid_t pi);
 225 typedef void (*port_fwd_end_t)(portid_t pi);
 226 typedef void (*packet_fwd_t)(struct fwd_stream *fs);
 227
 228 struct fwd_engine {
 229         const char       *fwd_mode_name; /**< Forwarding mode name. */
 230         port_fwd_begin_t port_fwd_begin; /**< NULL if nothing special to do. */
 231         port_fwd_end_t   port_fwd_end;   /**< NULL if nothing special to do. */
 232         packet_fwd_t     packet_fwd;     /**< Mandatory. */
 233 };
 234
 235 #define BURST_TX_WAIT_US 1
 236 #define BURST_TX_RETRIES 64
 237
 238 extern uint32_t burst_tx_delay_time;
 239 extern uint32_t burst_tx_retry_num;
 240
 241 extern struct fwd_engine io_fwd_engine;
 242 extern struct fwd_engine mac_fwd_engine;
 243 extern struct fwd_engine mac_swap_engine;
 244 extern struct fwd_engine flow_gen_engine;
 245 extern struct fwd_engine rx_only_engine;
 246 extern struct fwd_engine tx_only_engine;
 247 extern struct fwd_engine csum_fwd_engine;
 248 extern struct fwd_engine icmp_echo_engine;
 249 extern struct fwd_engine noisy_vnf_engine;
 250 #ifdef RTE_LIBRTE_IEEE1588
 251 extern struct fwd_engine ieee1588_fwd_engine;
 252 #endif
 253
 254 extern struct fwd_engine * fwd_engines[]; /**< NULL terminated array. */
 255 extern cmdline_parse_inst_t cmd_set_raw;
 256 extern cmdline_parse_inst_t cmd_show_set_raw;
 257 extern cmdline_parse_inst_t cmd_show_set_raw_all;
 258
 259 extern uint16_t mempool_flags;
 260
 261 /**
 262  * Forwarding Configuration
 263  *
 264  */
 265 struct fwd_config {
 266         struct fwd_engine *fwd_eng; /**< Packet forwarding mode. */
 267         streamid_t nb_fwd_streams;  /**< Nb. of forward streams to process. */
 268         lcoreid_t  nb_fwd_lcores;   /**< Nb. of logical cores to launch. */
 269         portid_t   nb_fwd_ports;    /**< Nb. of ports involved. */
 270 };
 271
 272 /**
 273  * DCB mode enable
 274  */
 275 enum dcb_mode_enable
 276 {
 277         DCB_VT_ENABLED,
 278         DCB_ENABLED
 279 };
 280
 281 #define MAX_TX_QUEUE_STATS_MAPPINGS 1024 /* MAX_PORT of 32 @ 32 tx_queues/port */
 282 #define MAX_RX_QUEUE_STATS_MAPPINGS 4096 /* MAX_PORT of 32 @ 128 rx_queues/port */
 283
 284 struct queue_stats_mappings {
 285         portid_t port_id;
 286         uint16_t queue_id;
 287         uint8_t stats_counter_id;
 288 } __rte_cache_aligned;
 289
 290 extern struct queue_stats_mappings tx_queue_stats_mappings_array[];
 291 extern struct queue_stats_mappings rx_queue_stats_mappings_array[];
 292
 293 /* Assign both tx and rx queue stats mappings to the same default values */
 294 extern struct queue_stats_mappings *tx_queue_stats_mappings;
 295 extern struct queue_stats_mappings *rx_queue_stats_mappings;
 296
 297 extern uint16_t nb_tx_queue_stats_mappings;
 298 extern uint16_t nb_rx_queue_stats_mappings;
 299
 300 extern uint8_t xstats_hide_zero; /**< Hide zero values for xstats display */
 301
 302 /* globals used for configuration */
 303 extern uint16_t verbose_level; /**< Drives messages being displayed, if any. */
 304 extern int testpmd_logtype; /**< Log type for testpmd logs */
 305 extern uint8_t  interactive;
 306 extern uint8_t  auto_start;
 307 extern uint8_t  tx_first;
 308 extern char cmdline_filename[PATH_MAX]; /**< offline commands file */
 309 extern uint8_t  numa_support; /**< set by "--numa" parameter */
 310 extern uint16_t port_topology; /**< set by "--port-topology" parameter */
 311 extern uint8_t no_flush_rx; /**<set by "--no-flush-rx" parameter */
 312 extern uint8_t flow_isolate_all; /**< set by "--flow-isolate-all */
 313 extern uint8_t  mp_alloc_type;
 314 /**< set by "--mp-anon" or "--mp-alloc" parameter */
 315 extern uint8_t no_link_check; /**<set by "--disable-link-check" parameter */
 316 extern uint8_t no_device_start; /**<set by "--disable-device-start" 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 extern bool setup_on_probe_event; /**< disabled by port setup-on iterator */
 323 extern uint8_t hot_plug; /**< enable by "--hot-plug" parameter */
 324 extern int do_mlockall; /**< set by "--mlockall" or "--no-mlockall" parameter */
 325 extern uint8_t clear_ptypes; /**< disabled by set ptype cmd */
 326
 327 #ifdef RTE_LIBRTE_IXGBE_BYPASS
 328 extern uint32_t bypass_timeout; /**< Store the NIC bypass watchdog timeout */
 329 #endif
 330
 331 /*
 332  * Store specified sockets on which memory pool to be used by ports
 333  * is allocated.
 334  */
 335 extern uint8_t port_numa[RTE_MAX_ETHPORTS];
 336
 337 /*
 338  * Store specified sockets on which RX ring to be used by ports
 339  * is allocated.
 340  */
 341 extern uint8_t rxring_numa[RTE_MAX_ETHPORTS];
 342
 343 /*
 344  * Store specified sockets on which TX ring to be used by ports
 345  * is allocated.
 346  */
 347 extern uint8_t txring_numa[RTE_MAX_ETHPORTS];
 348
 349 extern uint8_t socket_num;
 350
 351 /*
 352  * Configuration of logical cores:
 353  * nb_fwd_lcores <= nb_cfg_lcores <= nb_lcores
 354  */
 355 extern lcoreid_t nb_lcores; /**< Number of logical cores probed at init time. */
 356 extern lcoreid_t nb_cfg_lcores; /**< Number of configured logical cores. */
 357 extern lcoreid_t nb_fwd_lcores; /**< Number of forwarding logical cores. */
 358 extern unsigned int fwd_lcores_cpuids[RTE_MAX_LCORE];
 359 extern unsigned int num_sockets;
 360 extern unsigned int socket_ids[RTE_MAX_NUMA_NODES];
 361
 362 /*
 363  * Configuration of Ethernet ports:
 364  * nb_fwd_ports <= nb_cfg_ports <= nb_ports
 365  */
 366 extern portid_t nb_ports; /**< Number of ethernet ports probed at init time. */
 367 extern portid_t nb_cfg_ports; /**< Number of configured ports. */
 368 extern portid_t nb_fwd_ports; /**< Number of forwarding ports. */
 369 extern portid_t fwd_ports_ids[RTE_MAX_ETHPORTS];
 370 extern struct rte_port *ports;
 371
 372 extern struct rte_eth_rxmode rx_mode;
 373 extern struct rte_eth_txmode tx_mode;
 374
 375 extern uint64_t rss_hf;
 376
 377 extern queueid_t nb_hairpinq;
 378 extern queueid_t nb_rxq;
 379 extern queueid_t nb_txq;
 380
 381 extern uint16_t nb_rxd;
 382 extern uint16_t nb_txd;
 383
 384 extern int16_t rx_free_thresh;
 385 extern int8_t rx_drop_en;
 386 extern int16_t tx_free_thresh;
 387 extern int16_t tx_rs_thresh;
 388
 389 extern uint16_t noisy_tx_sw_bufsz;
 390 extern uint16_t noisy_tx_sw_buf_flush_time;
 391 extern uint64_t noisy_lkup_mem_sz;
 392 extern uint64_t noisy_lkup_num_writes;
 393 extern uint64_t noisy_lkup_num_reads;
 394 extern uint64_t noisy_lkup_num_reads_writes;
 395
 396 extern uint8_t dcb_config;
 397 extern uint8_t dcb_test;
 398
 399 extern uint16_t mbuf_data_size; /**< Mbuf data space size. */
 400 extern uint32_t param_total_num_mbufs;
 401
 402 extern uint16_t stats_period;
 403
 404 #ifdef RTE_LIBRTE_LATENCY_STATS
 405 extern uint8_t latencystats_enabled;
 406 extern lcoreid_t latencystats_lcore_id;
 407 #endif
 408
 409 #ifdef RTE_LIBRTE_BITRATE
 410 extern lcoreid_t bitrate_lcore_id;
 411 extern uint8_t bitrate_enabled;
 412 #endif
 413
 414 extern struct rte_fdir_conf fdir_conf;
 415
 416 /*
 417  * Configuration of packet segments used by the "txonly" processing engine.
 418  */
 419 #define TXONLY_DEF_PACKET_LEN 64
 420 extern uint16_t tx_pkt_length; /**< Length of TXONLY packet */
 421 extern uint16_t tx_pkt_seg_lengths[RTE_MAX_SEGS_PER_PKT]; /**< Seg. lengths */
 422 extern uint8_t  tx_pkt_nb_segs; /**< Number of segments in TX packets */
 423
 424 enum tx_pkt_split {
 425         TX_PKT_SPLIT_OFF,
 426         TX_PKT_SPLIT_ON,
 427         TX_PKT_SPLIT_RND,
 428 };
 429
 430 extern enum tx_pkt_split tx_pkt_split;
 431
 432 extern uint8_t txonly_multi_flow;
 433
 434 extern uint16_t nb_pkt_per_burst;
 435 extern uint16_t mb_mempool_cache;
 436 extern int8_t rx_pthresh;
 437 extern int8_t rx_hthresh;
 438 extern int8_t rx_wthresh;
 439 extern int8_t tx_pthresh;
 440 extern int8_t tx_hthresh;
 441 extern int8_t tx_wthresh;
 442
 443 extern uint16_t tx_udp_src_port;
 444 extern uint16_t tx_udp_dst_port;
 445
 446 extern uint32_t tx_ip_src_addr;
 447 extern uint32_t tx_ip_dst_addr;
 448
 449 extern struct fwd_config cur_fwd_config;
 450 extern struct fwd_engine *cur_fwd_eng;
 451 extern uint32_t retry_enabled;
 452 extern struct fwd_lcore  **fwd_lcores;
 453 extern struct fwd_stream **fwd_streams;
 454
 455 extern uint16_t vxlan_gpe_udp_port; /**< UDP port of tunnel VXLAN-GPE. */
 456
 457 extern portid_t nb_peer_eth_addrs; /**< Number of peer ethernet addresses. */
 458 extern struct rte_ether_addr peer_eth_addrs[RTE_MAX_ETHPORTS];
 459
 460 extern uint32_t burst_tx_delay_time; /**< Burst tx delay time(us) for mac-retry. */
 461 extern uint32_t burst_tx_retry_num;  /**< Burst tx retry number for mac-retry. */
 462
 463 #define GRO_DEFAULT_ITEM_NUM_PER_FLOW 32
 464 #define GRO_DEFAULT_FLOW_NUM (RTE_GRO_MAX_BURST_ITEM_NUM / \
 465                 GRO_DEFAULT_ITEM_NUM_PER_FLOW)
 466
 467 #define GRO_DEFAULT_FLUSH_CYCLES 1
 468 #define GRO_MAX_FLUSH_CYCLES 4
 469
 470 struct gro_status {
 471         struct rte_gro_param param;
 472         uint8_t enable;
 473 };
 474 extern struct gro_status gro_ports[RTE_MAX_ETHPORTS];
 475 extern uint8_t gro_flush_cycles;
 476
 477 #define GSO_MAX_PKT_BURST 2048
 478 struct gso_status {
 479         uint8_t enable;
 480 };
 481 extern struct gso_status gso_ports[RTE_MAX_ETHPORTS];
 482 extern uint16_t gso_max_segment_size;
 483
 484 /* VXLAN encap/decap parameters. */
 485 struct vxlan_encap_conf {
 486         uint32_t select_ipv4:1;
 487         uint32_t select_vlan:1;
 488         uint32_t select_tos_ttl:1;
 489         uint8_t vni[3];
 490         rte_be16_t udp_src;
 491         rte_be16_t udp_dst;
 492         rte_be32_t ipv4_src;
 493         rte_be32_t ipv4_dst;
 494         uint8_t ipv6_src[16];
 495         uint8_t ipv6_dst[16];
 496         rte_be16_t vlan_tci;
 497         uint8_t ip_tos;
 498         uint8_t ip_ttl;
 499         uint8_t eth_src[RTE_ETHER_ADDR_LEN];
 500         uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
 501 };
 502
 503 extern struct vxlan_encap_conf vxlan_encap_conf;
 504
 505 /* NVGRE encap/decap parameters. */
 506 struct nvgre_encap_conf {
 507         uint32_t select_ipv4:1;
 508         uint32_t select_vlan:1;
 509         uint8_t tni[3];
 510         rte_be32_t ipv4_src;
 511         rte_be32_t ipv4_dst;
 512         uint8_t ipv6_src[16];
 513         uint8_t ipv6_dst[16];
 514         rte_be16_t vlan_tci;
 515         uint8_t eth_src[RTE_ETHER_ADDR_LEN];
 516         uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
 517 };
 518
 519 extern struct nvgre_encap_conf nvgre_encap_conf;
 520
 521 /* L2 encap parameters. */
 522 struct l2_encap_conf {
 523         uint32_t select_ipv4:1;
 524         uint32_t select_vlan:1;
 525         rte_be16_t vlan_tci;
 526         uint8_t eth_src[RTE_ETHER_ADDR_LEN];
 527         uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
 528 };
 529 extern struct l2_encap_conf l2_encap_conf;
 530
 531 /* L2 decap parameters. */
 532 struct l2_decap_conf {
 533         uint32_t select_vlan:1;
 534 };
 535 extern struct l2_decap_conf l2_decap_conf;
 536
 537 /* MPLSoGRE encap parameters. */
 538 struct mplsogre_encap_conf {
 539         uint32_t select_ipv4:1;
 540         uint32_t select_vlan:1;
 541         uint8_t label[3];
 542         rte_be32_t ipv4_src;
 543         rte_be32_t ipv4_dst;
 544         uint8_t ipv6_src[16];
 545         uint8_t ipv6_dst[16];
 546         rte_be16_t vlan_tci;
 547         uint8_t eth_src[RTE_ETHER_ADDR_LEN];
 548         uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
 549 };
 550 extern struct mplsogre_encap_conf mplsogre_encap_conf;
 551
 552 /* MPLSoGRE decap parameters. */
 553 struct mplsogre_decap_conf {
 554         uint32_t select_ipv4:1;
 555         uint32_t select_vlan:1;
 556 };
 557 extern struct mplsogre_decap_conf mplsogre_decap_conf;
 558
 559 /* MPLSoUDP encap parameters. */
 560 struct mplsoudp_encap_conf {
 561         uint32_t select_ipv4:1;
 562         uint32_t select_vlan:1;
 563         uint8_t label[3];
 564         rte_be16_t udp_src;
 565         rte_be16_t udp_dst;
 566         rte_be32_t ipv4_src;
 567         rte_be32_t ipv4_dst;
 568         uint8_t ipv6_src[16];
 569         uint8_t ipv6_dst[16];
 570         rte_be16_t vlan_tci;
 571         uint8_t eth_src[RTE_ETHER_ADDR_LEN];
 572         uint8_t eth_dst[RTE_ETHER_ADDR_LEN];
 573 };
 574 extern struct mplsoudp_encap_conf mplsoudp_encap_conf;
 575
 576 /* MPLSoUDP decap parameters. */
 577 struct mplsoudp_decap_conf {
 578         uint32_t select_ipv4:1;
 579         uint32_t select_vlan:1;
 580 };
 581 extern struct mplsoudp_decap_conf mplsoudp_decap_conf;
 582
 583 extern enum rte_eth_rx_mq_mode rx_mq_mode;
 584
 585 static inline unsigned int
 586 lcore_num(void)
 587 {
 588         unsigned int i;
 589
 590         for (i = 0; i < RTE_MAX_LCORE; ++i)
 591                 if (fwd_lcores_cpuids[i] == rte_lcore_id())
 592                         return i;
 593
 594         rte_panic("lcore_id of current thread not found in fwd_lcores_cpuids\n");
 595 }
 596
 597 void
 598 parse_fwd_portlist(const char *port);
 599
 600 static inline struct fwd_lcore *
 601 current_fwd_lcore(void)
 602 {
 603         return fwd_lcores[lcore_num()];
 604 }
 605
 606 /* Mbuf Pools */
 607 static inline void
 608 mbuf_poolname_build(unsigned int sock_id, char* mp_name, int name_size)
 609 {
 610         snprintf(mp_name, name_size, "mbuf_pool_socket_%u", sock_id);
 611 }
 612
 613 static inline struct rte_mempool *
 614 mbuf_pool_find(unsigned int sock_id)
 615 {
 616         char pool_name[RTE_MEMPOOL_NAMESIZE];
 617
 618         mbuf_poolname_build(sock_id, pool_name, sizeof(pool_name));
 619         return rte_mempool_lookup((const char *)pool_name);
 620 }
 621
 622 /**
 623  * Read/Write operations on a PCI register of a port.
 624  */
 625 static inline uint32_t
 626 port_pci_reg_read(struct rte_port *port, uint32_t reg_off)
 627 {
 628         const struct rte_pci_device *pci_dev;
 629         const struct rte_bus *bus;
 630         void *reg_addr;
 631         uint32_t reg_v;
 632
 633         if (!port->dev_info.device) {
 634                 printf("Invalid device\n");
 635                 return 0;
 636         }
 637
 638         bus = rte_bus_find_by_device(port->dev_info.device);
 639         if (bus && !strcmp(bus->name, "pci")) {
 640                 pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
 641         } else {
 642                 printf("Not a PCI device\n");
 643                 return 0;
 644         }
 645
 646         reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
 647         reg_v = *((volatile uint32_t *)reg_addr);
 648         return rte_le_to_cpu_32(reg_v);
 649 }
 650
 651 #define port_id_pci_reg_read(pt_id, reg_off) \
 652         port_pci_reg_read(&ports[(pt_id)], (reg_off))
 653
 654 static inline void
 655 port_pci_reg_write(struct rte_port *port, uint32_t reg_off, uint32_t reg_v)
 656 {
 657         const struct rte_pci_device *pci_dev;
 658         const struct rte_bus *bus;
 659         void *reg_addr;
 660
 661         if (!port->dev_info.device) {
 662                 printf("Invalid device\n");
 663                 return;
 664         }
 665
 666         bus = rte_bus_find_by_device(port->dev_info.device);
 667         if (bus && !strcmp(bus->name, "pci")) {
 668                 pci_dev = RTE_DEV_TO_PCI(port->dev_info.device);
 669         } else {
 670                 printf("Not a PCI device\n");
 671                 return;
 672         }
 673
 674         reg_addr = ((char *)pci_dev->mem_resource[0].addr + reg_off);
 675         *((volatile uint32_t *)reg_addr) = rte_cpu_to_le_32(reg_v);
 676 }
 677
 678 #define port_id_pci_reg_write(pt_id, reg_off, reg_value) \
 679         port_pci_reg_write(&ports[(pt_id)], (reg_off), (reg_value))
 680
 681 /* Prototypes */
 682 unsigned int parse_item_list(char* str, const char* item_name,
 683                         unsigned int max_items,
 684                         unsigned int *parsed_items, int check_unique_values);
 685 void launch_args_parse(int argc, char** argv);
 686 void cmdline_read_from_file(const char *filename);
 687 void prompt(void);
 688 void prompt_exit(void);
 689 void nic_stats_display(portid_t port_id);
 690 void nic_stats_clear(portid_t port_id);
 691 void nic_xstats_display(portid_t port_id);
 692 void nic_xstats_clear(portid_t port_id);
 693 void nic_stats_mapping_display(portid_t port_id);
 694 void device_infos_display(const char *identifier);
 695 void port_infos_display(portid_t port_id);
 696 void port_summary_display(portid_t port_id);
 697 void port_summary_header_display(void);
 698 void port_offload_cap_display(portid_t port_id);
 699 void rx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
 700 void tx_queue_infos_display(portid_t port_idi, uint16_t queue_id);
 701 void fwd_lcores_config_display(void);
 702 void pkt_fwd_config_display(struct fwd_config *cfg);
 703 void rxtx_config_display(void);
 704 void fwd_config_setup(void);
 705 void set_def_fwd_config(void);
 706 void reconfig(portid_t new_port_id, unsigned socket_id);
 707 int init_fwd_streams(void);
 708 void update_fwd_ports(portid_t new_pid);
 709
 710 void set_fwd_eth_peer(portid_t port_id, char *peer_addr);
 711
 712 void port_mtu_set(portid_t port_id, uint16_t mtu);
 713 void port_reg_bit_display(portid_t port_id, uint32_t reg_off, uint8_t bit_pos);
 714 void port_reg_bit_set(portid_t port_id, uint32_t reg_off, uint8_t bit_pos,
 715                       uint8_t bit_v);
 716 void port_reg_bit_field_display(portid_t port_id, uint32_t reg_off,
 717                                 uint8_t bit1_pos, uint8_t bit2_pos);
 718 void port_reg_bit_field_set(portid_t port_id, uint32_t reg_off,
 719                             uint8_t bit1_pos, uint8_t bit2_pos, uint32_t value);
 720 void port_reg_display(portid_t port_id, uint32_t reg_off);
 721 void port_reg_set(portid_t port_id, uint32_t reg_off, uint32_t value);
 722 int port_flow_validate(portid_t port_id,
 723                        const struct rte_flow_attr *attr,
 724                        const struct rte_flow_item *pattern,
 725                        const struct rte_flow_action *actions);
 726 int port_flow_create(portid_t port_id,
 727                      const struct rte_flow_attr *attr,
 728                      const struct rte_flow_item *pattern,
 729                      const struct rte_flow_action *actions);
 730 void update_age_action_context(const struct rte_flow_action *actions,
 731                      struct port_flow *pf);
 732 int port_flow_destroy(portid_t port_id, uint32_t n, const uint32_t *rule);
 733 int port_flow_flush(portid_t port_id);
 734 int port_flow_dump(portid_t port_id, const char *file_name);
 735 int port_flow_query(portid_t port_id, uint32_t rule,
 736                     const struct rte_flow_action *action);
 737 void port_flow_list(portid_t port_id, uint32_t n, const uint32_t *group);
 738 void port_flow_aged(portid_t port_id, uint8_t destroy);
 739 int port_flow_isolate(portid_t port_id, int set);
 740
 741 void rx_ring_desc_display(portid_t port_id, queueid_t rxq_id, uint16_t rxd_id);
 742 void tx_ring_desc_display(portid_t port_id, queueid_t txq_id, uint16_t txd_id);
 743
 744 int set_fwd_lcores_list(unsigned int *lcorelist, unsigned int nb_lc);
 745 int set_fwd_lcores_mask(uint64_t lcoremask);
 746 void set_fwd_lcores_number(uint16_t nb_lc);
 747
 748 void set_fwd_ports_list(unsigned int *portlist, unsigned int nb_pt);
 749 void set_fwd_ports_mask(uint64_t portmask);
 750 void set_fwd_ports_number(uint16_t nb_pt);
 751 int port_is_forwarding(portid_t port_id);
 752
 753 void rx_vlan_strip_set(portid_t port_id, int on);
 754 void rx_vlan_strip_set_on_queue(portid_t port_id, uint16_t queue_id, int on);
 755
 756 void rx_vlan_filter_set(portid_t port_id, int on);
 757 void rx_vlan_all_filter_set(portid_t port_id, int on);
 758 void rx_vlan_qinq_strip_set(portid_t port_id, int on);
 759 int rx_vft_set(portid_t port_id, uint16_t vlan_id, int on);
 760 void vlan_extend_set(portid_t port_id, int on);
 761 void vlan_tpid_set(portid_t port_id, enum rte_vlan_type vlan_type,
 762                    uint16_t tp_id);
 763 void tx_vlan_set(portid_t port_id, uint16_t vlan_id);
 764 void tx_qinq_set(portid_t port_id, uint16_t vlan_id, uint16_t vlan_id_outer);
 765 void tx_vlan_reset(portid_t port_id);
 766 void tx_vlan_pvid_set(portid_t port_id, uint16_t vlan_id, int on);
 767
 768 void set_qmap(portid_t port_id, uint8_t is_rx, uint16_t queue_id, uint8_t map_value);
 769
 770 void set_xstats_hide_zero(uint8_t on_off);
 771
 772 void set_verbose_level(uint16_t vb_level);
 773 void set_tx_pkt_segments(unsigned *seg_lengths, unsigned nb_segs);
 774 void show_tx_pkt_segments(void);
 775 void set_tx_pkt_split(const char *name);
 776 void set_nb_pkt_per_burst(uint16_t pkt_burst);
 777 char *list_pkt_forwarding_modes(void);
 778 char *list_pkt_forwarding_retry_modes(void);
 779 void set_pkt_forwarding_mode(const char *fwd_mode);
 780 void start_packet_forwarding(int with_tx_first);
 781 void fwd_stats_display(void);
 782 void fwd_stats_reset(void);
 783 void stop_packet_forwarding(void);
 784 void dev_set_link_up(portid_t pid);
 785 void dev_set_link_down(portid_t pid);
 786 void init_port_config(void);
 787 void set_port_slave_flag(portid_t slave_pid);
 788 void clear_port_slave_flag(portid_t slave_pid);
 789 uint8_t port_is_bonding_slave(portid_t slave_pid);
 790
 791 int init_port_dcb_config(portid_t pid, enum dcb_mode_enable dcb_mode,
 792                      enum rte_eth_nb_tcs num_tcs,
 793                      uint8_t pfc_en);
 794 int start_port(portid_t pid);
 795 void stop_port(portid_t pid);
 796 void close_port(portid_t pid);
 797 void reset_port(portid_t pid);
 798 void attach_port(char *identifier);
 799 void detach_devargs(char *identifier);
 800 void detach_port_device(portid_t port_id);
 801 int all_ports_stopped(void);
 802 int port_is_stopped(portid_t port_id);
 803 int port_is_started(portid_t port_id);
 804 void pmd_test_exit(void);
 805 void fdir_get_infos(portid_t port_id);
 806 void fdir_set_flex_mask(portid_t port_id,
 807                            struct rte_eth_fdir_flex_mask *cfg);
 808 void fdir_set_flex_payload(portid_t port_id,
 809                            struct rte_eth_flex_payload_cfg *cfg);
 810 void port_rss_reta_info(portid_t port_id,
 811                         struct rte_eth_rss_reta_entry64 *reta_conf,
 812                         uint16_t nb_entries);
 813
 814 void set_vf_traffic(portid_t port_id, uint8_t is_rx, uint16_t vf, uint8_t on);
 815
 816 int set_queue_rate_limit(portid_t port_id, uint16_t queue_idx, uint16_t rate);
 817 int set_vf_rate_limit(portid_t port_id, uint16_t vf, uint16_t rate,
 818                                 uint64_t q_msk);
 819
 820 void port_rss_hash_conf_show(portid_t port_id, int show_rss_key);
 821 void port_rss_hash_key_update(portid_t port_id, char rss_type[],
 822                               uint8_t *hash_key, uint hash_key_len);
 823 int rx_queue_id_is_invalid(queueid_t rxq_id);
 824 int tx_queue_id_is_invalid(queueid_t txq_id);
 825 void setup_gro(const char *onoff, portid_t port_id);
 826 void setup_gro_flush_cycles(uint8_t cycles);
 827 void show_gro(portid_t port_id);
 828 void setup_gso(const char *mode, portid_t port_id);
 829 int eth_dev_info_get_print_err(uint16_t port_id,
 830                         struct rte_eth_dev_info *dev_info);
 831 void eth_set_promisc_mode(uint16_t port_id, int enable);
 832 void eth_set_allmulticast_mode(uint16_t port, int enable);
 833 int eth_link_get_nowait_print_err(uint16_t port_id, struct rte_eth_link *link);
 834 int eth_macaddr_get_print_err(uint16_t port_id,
 835                         struct rte_ether_addr *mac_addr);
 836
 837 /* Functions to display the set of MAC addresses added to a port*/
 838 void show_macs(portid_t port_id);
 839 void show_mcast_macs(portid_t port_id);
 840
 841 /* Functions to manage the set of filtered Multicast MAC addresses */
 842 void mcast_addr_add(portid_t port_id, struct rte_ether_addr *mc_addr);
 843 void mcast_addr_remove(portid_t port_id, struct rte_ether_addr *mc_addr);
 844 void port_dcb_info_display(portid_t port_id);
 845
 846 uint8_t *open_file(const char *file_path, uint32_t *size);
 847 int save_file(const char *file_path, uint8_t *buf, uint32_t size);
 848 int close_file(uint8_t *buf);
 849
 850 void port_queue_region_info_display(portid_t port_id, void *buf);
 851
 852 enum print_warning {
 853         ENABLED_WARN = 0,
 854         DISABLED_WARN
 855 };
 856 int port_id_is_invalid(portid_t port_id, enum print_warning warning);
 857 void print_valid_ports(void);
 858 int new_socket_id(unsigned int socket_id);
 859
 860 queueid_t get_allowed_max_nb_rxq(portid_t *pid);
 861 int check_nb_rxq(queueid_t rxq);
 862 queueid_t get_allowed_max_nb_txq(portid_t *pid);
 863 int check_nb_txq(queueid_t txq);
 864 int check_nb_rxd(queueid_t rxd);
 865 int check_nb_txd(queueid_t txd);
 866 queueid_t get_allowed_max_nb_hairpinq(portid_t *pid);
 867 int check_nb_hairpinq(queueid_t hairpinq);
 868
 869 uint16_t dump_rx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
 870                       uint16_t nb_pkts, __rte_unused uint16_t max_pkts,
 871                       __rte_unused void *user_param);
 872
 873 uint16_t dump_tx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
 874                       uint16_t nb_pkts, __rte_unused void *user_param);
 875
 876 void add_rx_dump_callbacks(portid_t portid);
 877 void remove_rx_dump_callbacks(portid_t portid);
 878 void add_tx_dump_callbacks(portid_t portid);
 879 void remove_tx_dump_callbacks(portid_t portid);
 880 void configure_rxtx_dump_callbacks(uint16_t verbose);
 881
 882 uint16_t tx_pkt_set_md(uint16_t port_id, __rte_unused uint16_t queue,
 883                        struct rte_mbuf *pkts[], uint16_t nb_pkts,
 884                        __rte_unused void *user_param);
 885 void add_tx_md_callback(portid_t portid);
 886 void remove_tx_md_callback(portid_t portid);
 887
 888 uint16_t tx_pkt_set_dynf(uint16_t port_id, __rte_unused uint16_t queue,
 889                          struct rte_mbuf *pkts[], uint16_t nb_pkts,
 890                          __rte_unused void *user_param);
 891 void add_tx_dynf_callback(portid_t portid);
 892 void remove_tx_dynf_callback(portid_t portid);
 893
 894 /*
 895  * Work-around of a compilation error with ICC on invocations of the
 896  * rte_be_to_cpu_16() function.
 897  */
 898 #ifdef __GCC__
 899 #define RTE_BE_TO_CPU_16(be_16_v)  rte_be_to_cpu_16((be_16_v))
 900 #define RTE_CPU_TO_BE_16(cpu_16_v) rte_cpu_to_be_16((cpu_16_v))
 901 #else
 902 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
 903 #define RTE_BE_TO_CPU_16(be_16_v)  (be_16_v)
 904 #define RTE_CPU_TO_BE_16(cpu_16_v) (cpu_16_v)
 905 #else
 906 #define RTE_BE_TO_CPU_16(be_16_v) \
 907         (uint16_t) ((((be_16_v) & 0xFF) << 8) | ((be_16_v) >> 8))
 908 #define RTE_CPU_TO_BE_16(cpu_16_v) \
 909         (uint16_t) ((((cpu_16_v) & 0xFF) << 8) | ((cpu_16_v) >> 8))
 910 #endif
 911 #endif /* __GCC__ */
 912
 913 #define TESTPMD_LOG(level, fmt, args...) \
 914         rte_log(RTE_LOG_ ## level, testpmd_logtype, "testpmd: " fmt, ## args)
 915
 916 #endif /* _TESTPMD_H_ */