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