app/test-pmd/util.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  * Copyright 2018 Mellanox Technologies, Ltd
   4  */
   5
   6 #include <stdio.h>
   7
   8 #include <rte_bitops.h>
   9 #include <rte_net.h>
  10 #include <rte_mbuf.h>
  11 #include <rte_ether.h>
  12 #include <rte_vxlan.h>
  13 #include <rte_ethdev.h>
  14 #include <rte_flow.h>
  15
  16 #include "testpmd.h"
  17
  18 #define MAX_STRING_LEN 8192
  19
  20 #define MKDUMPSTR(buf, buf_size, cur_len, ...) \
  21 do { \
  22         if (cur_len >= buf_size) \
  23                 break; \
  24         cur_len += snprintf(buf + cur_len, buf_size - cur_len, __VA_ARGS__); \
  25 } while (0)
  26
  27 static inline void
  28 print_ether_addr(const char *what, const struct rte_ether_addr *eth_addr,
  29                  char print_buf[], size_t buf_size, size_t *cur_len)
  30 {
  31         char buf[RTE_ETHER_ADDR_FMT_SIZE];
  32
  33         rte_ether_format_addr(buf, RTE_ETHER_ADDR_FMT_SIZE, eth_addr);
  34         MKDUMPSTR(print_buf, buf_size, *cur_len, "%s%s", what, buf);
  35 }
  36
  37 static inline bool
  38 is_timestamp_enabled(const struct rte_mbuf *mbuf)
  39 {
  40         static uint64_t timestamp_rx_dynflag;
  41         int timestamp_rx_dynflag_offset;
  42
  43         if (timestamp_rx_dynflag == 0) {
  44                 timestamp_rx_dynflag_offset = rte_mbuf_dynflag_lookup(
  45                                 RTE_MBUF_DYNFLAG_RX_TIMESTAMP_NAME, NULL);
  46                 if (timestamp_rx_dynflag_offset < 0)
  47                         return false;
  48                 timestamp_rx_dynflag = RTE_BIT64(timestamp_rx_dynflag_offset);
  49         }
  50
  51         return (mbuf->ol_flags & timestamp_rx_dynflag) != 0;
  52 }
  53
  54 static inline rte_mbuf_timestamp_t
  55 get_timestamp(const struct rte_mbuf *mbuf)
  56 {
  57         static int timestamp_dynfield_offset = -1;
  58
  59         if (timestamp_dynfield_offset < 0) {
  60                 timestamp_dynfield_offset = rte_mbuf_dynfield_lookup(
  61                                 RTE_MBUF_DYNFIELD_TIMESTAMP_NAME, NULL);
  62                 if (timestamp_dynfield_offset < 0)
  63                         return 0;
  64         }
  65
  66         return *RTE_MBUF_DYNFIELD(mbuf,
  67                         timestamp_dynfield_offset, rte_mbuf_timestamp_t *);
  68 }
  69
  70 static inline void
  71 dump_pkt_burst(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
  72               uint16_t nb_pkts, int is_rx)
  73 {
  74         struct rte_mbuf  *mb;
  75         const struct rte_ether_hdr *eth_hdr;
  76         struct rte_ether_hdr _eth_hdr;
  77         uint16_t eth_type;
  78         uint64_t ol_flags;
  79         uint16_t i, packet_type;
  80         uint16_t is_encapsulation;
  81         char buf[256];
  82         struct rte_net_hdr_lens hdr_lens;
  83         uint32_t sw_packet_type;
  84         uint16_t udp_port;
  85         uint32_t vx_vni;
  86         const char *reason;
  87         int dynf_index;
  88         char print_buf[MAX_STRING_LEN];
  89         size_t buf_size = MAX_STRING_LEN;
  90         size_t cur_len = 0;
  91
  92         if (!nb_pkts)
  93                 return;
  94         MKDUMPSTR(print_buf, buf_size, cur_len,
  95                   "port %u/queue %u: %s %u packets\n", port_id, queue,
  96                   is_rx ? "received" : "sent", (unsigned int) nb_pkts);
  97         for (i = 0; i < nb_pkts; i++) {
  98                 int ret;
  99                 struct rte_flow_error error;
 100                 struct rte_flow_restore_info info = { 0, };
 101
 102                 mb = pkts[i];
 103                 eth_hdr = rte_pktmbuf_read(mb, 0, sizeof(_eth_hdr), &_eth_hdr);
 104                 eth_type = RTE_BE_TO_CPU_16(eth_hdr->ether_type);
 105                 packet_type = mb->packet_type;
 106                 is_encapsulation = RTE_ETH_IS_TUNNEL_PKT(packet_type);
 107                 ret = rte_flow_get_restore_info(port_id, mb, &info, &error);
 108                 if (!ret) {
 109                         MKDUMPSTR(print_buf, buf_size, cur_len,
 110                                   "restore info:");
 111                         if (info.flags & RTE_FLOW_RESTORE_INFO_TUNNEL) {
 112                                 struct port_flow_tunnel *port_tunnel;
 113
 114                                 port_tunnel = port_flow_locate_tunnel
 115                                               (port_id, &info.tunnel);
 116                                 MKDUMPSTR(print_buf, buf_size, cur_len,
 117                                           " - tunnel");
 118                                 if (port_tunnel)
 119                                         MKDUMPSTR(print_buf, buf_size, cur_len,
 120                                                   " #%u", port_tunnel->id);
 121                                 else
 122                                         MKDUMPSTR(print_buf, buf_size, cur_len,
 123                                                   " %s", "-none-");
 124                                 MKDUMPSTR(print_buf, buf_size, cur_len,
 125                                           " type %s", port_flow_tunnel_type
 126                                           (&info.tunnel));
 127                         } else {
 128                                 MKDUMPSTR(print_buf, buf_size, cur_len,
 129                                           " - no tunnel info");
 130                         }
 131                         if (info.flags & RTE_FLOW_RESTORE_INFO_ENCAPSULATED)
 132                                 MKDUMPSTR(print_buf, buf_size, cur_len,
 133                                           " - outer header present");
 134                         else
 135                                 MKDUMPSTR(print_buf, buf_size, cur_len,
 136                                           " - no outer header");
 137                         if (info.flags & RTE_FLOW_RESTORE_INFO_GROUP_ID)
 138                                 MKDUMPSTR(print_buf, buf_size, cur_len,
 139                                           " - miss group %u", info.group_id);
 140                         else
 141                                 MKDUMPSTR(print_buf, buf_size, cur_len,
 142                                           " - no miss group");
 143                         MKDUMPSTR(print_buf, buf_size, cur_len, "\n");
 144                 }
 145                 print_ether_addr("  src=", &eth_hdr->src_addr,
 146                                  print_buf, buf_size, &cur_len);
 147                 print_ether_addr(" - dst=", &eth_hdr->dst_addr,
 148                                  print_buf, buf_size, &cur_len);
 149                 MKDUMPSTR(print_buf, buf_size, cur_len,
 150                           " - type=0x%04x - length=%u - nb_segs=%d",
 151                           eth_type, (unsigned int) mb->pkt_len,
 152                           (int)mb->nb_segs);
 153                 ol_flags = mb->ol_flags;
 154                 if (ol_flags & PKT_RX_RSS_HASH) {
 155                         MKDUMPSTR(print_buf, buf_size, cur_len,
 156                                   " - RSS hash=0x%x",
 157                                   (unsigned int) mb->hash.rss);
 158                         MKDUMPSTR(print_buf, buf_size, cur_len,
 159                                   " - RSS queue=0x%x", (unsigned int) queue);
 160                 }
 161                 if (ol_flags & PKT_RX_FDIR) {
 162                         MKDUMPSTR(print_buf, buf_size, cur_len,
 163                                   " - FDIR matched ");
 164                         if (ol_flags & PKT_RX_FDIR_ID)
 165                                 MKDUMPSTR(print_buf, buf_size, cur_len,
 166                                           "ID=0x%x", mb->hash.fdir.hi);
 167                         else if (ol_flags & PKT_RX_FDIR_FLX)
 168                                 MKDUMPSTR(print_buf, buf_size, cur_len,
 169                                           "flex bytes=0x%08x %08x",
 170                                           mb->hash.fdir.hi, mb->hash.fdir.lo);
 171                         else
 172                                 MKDUMPSTR(print_buf, buf_size, cur_len,
 173                                           "hash=0x%x ID=0x%x ",
 174                                           mb->hash.fdir.hash, mb->hash.fdir.id);
 175                 }
 176                 if (is_timestamp_enabled(mb))
 177                         MKDUMPSTR(print_buf, buf_size, cur_len,
 178                                   " - timestamp %"PRIu64" ", get_timestamp(mb));
 179                 if (ol_flags & PKT_RX_QINQ)
 180                         MKDUMPSTR(print_buf, buf_size, cur_len,
 181                                   " - QinQ VLAN tci=0x%x, VLAN tci outer=0x%x",
 182                                   mb->vlan_tci, mb->vlan_tci_outer);
 183                 else if (ol_flags & PKT_RX_VLAN)
 184                         MKDUMPSTR(print_buf, buf_size, cur_len,
 185                                   " - VLAN tci=0x%x", mb->vlan_tci);
 186                 if (!is_rx && (ol_flags & PKT_TX_DYNF_METADATA))
 187                         MKDUMPSTR(print_buf, buf_size, cur_len,
 188                                   " - Tx metadata: 0x%x",
 189                                   *RTE_FLOW_DYNF_METADATA(mb));
 190                 if (is_rx && (ol_flags & PKT_RX_DYNF_METADATA))
 191                         MKDUMPSTR(print_buf, buf_size, cur_len,
 192                                   " - Rx metadata: 0x%x",
 193                                   *RTE_FLOW_DYNF_METADATA(mb));
 194                 for (dynf_index = 0; dynf_index < 64; dynf_index++) {
 195                         if (dynf_names[dynf_index][0] != '\0')
 196                                 MKDUMPSTR(print_buf, buf_size, cur_len,
 197                                           " - dynf %s: %d",
 198                                           dynf_names[dynf_index],
 199                                           !!(ol_flags & (1UL << dynf_index)));
 200                 }
 201                 if (mb->packet_type) {
 202                         rte_get_ptype_name(mb->packet_type, buf, sizeof(buf));
 203                         MKDUMPSTR(print_buf, buf_size, cur_len,
 204                                   " - hw ptype: %s", buf);
 205                 }
 206                 sw_packet_type = rte_net_get_ptype(mb, &hdr_lens,
 207                                         RTE_PTYPE_ALL_MASK);
 208                 rte_get_ptype_name(sw_packet_type, buf, sizeof(buf));
 209                 MKDUMPSTR(print_buf, buf_size, cur_len, " - sw ptype: %s", buf);
 210                 if (sw_packet_type & RTE_PTYPE_L2_MASK)
 211                         MKDUMPSTR(print_buf, buf_size, cur_len, " - l2_len=%d",
 212                                   hdr_lens.l2_len);
 213                 if (sw_packet_type & RTE_PTYPE_L3_MASK)
 214                         MKDUMPSTR(print_buf, buf_size, cur_len, " - l3_len=%d",
 215                                   hdr_lens.l3_len);
 216                 if (sw_packet_type & RTE_PTYPE_L4_MASK)
 217                         MKDUMPSTR(print_buf, buf_size, cur_len, " - l4_len=%d",
 218                                   hdr_lens.l4_len);
 219                 if (sw_packet_type & RTE_PTYPE_TUNNEL_MASK)
 220                         MKDUMPSTR(print_buf, buf_size, cur_len,
 221                                   " - tunnel_len=%d", hdr_lens.tunnel_len);
 222                 if (sw_packet_type & RTE_PTYPE_INNER_L2_MASK)
 223                         MKDUMPSTR(print_buf, buf_size, cur_len,
 224                                   " - inner_l2_len=%d", hdr_lens.inner_l2_len);
 225                 if (sw_packet_type & RTE_PTYPE_INNER_L3_MASK)
 226                         MKDUMPSTR(print_buf, buf_size, cur_len,
 227                                   " - inner_l3_len=%d", hdr_lens.inner_l3_len);
 228                 if (sw_packet_type & RTE_PTYPE_INNER_L4_MASK)
 229                         MKDUMPSTR(print_buf, buf_size, cur_len,
 230                                   " - inner_l4_len=%d", hdr_lens.inner_l4_len);
 231                 if (is_encapsulation) {
 232                         struct rte_ipv4_hdr *ipv4_hdr;
 233                         struct rte_ipv6_hdr *ipv6_hdr;
 234                         struct rte_udp_hdr *udp_hdr;
 235                         uint8_t l2_len;
 236                         uint8_t l3_len;
 237                         uint8_t l4_len;
 238                         uint8_t l4_proto;
 239                         struct  rte_vxlan_hdr *vxlan_hdr;
 240
 241                         l2_len  = sizeof(struct rte_ether_hdr);
 242
 243                         /* Do not support ipv4 option field */
 244                         if (RTE_ETH_IS_IPV4_HDR(packet_type)) {
 245                                 l3_len = sizeof(struct rte_ipv4_hdr);
 246                                 ipv4_hdr = rte_pktmbuf_mtod_offset(mb,
 247                                 struct rte_ipv4_hdr *,
 248                                 l2_len);
 249                                 l4_proto = ipv4_hdr->next_proto_id;
 250                         } else {
 251                                 l3_len = sizeof(struct rte_ipv6_hdr);
 252                                 ipv6_hdr = rte_pktmbuf_mtod_offset(mb,
 253                                 struct rte_ipv6_hdr *,
 254                                 l2_len);
 255                                 l4_proto = ipv6_hdr->proto;
 256                         }
 257                         if (l4_proto == IPPROTO_UDP) {
 258                                 udp_hdr = rte_pktmbuf_mtod_offset(mb,
 259                                 struct rte_udp_hdr *,
 260                                 l2_len + l3_len);
 261                                 l4_len = sizeof(struct rte_udp_hdr);
 262                                 vxlan_hdr = rte_pktmbuf_mtod_offset(mb,
 263                                 struct rte_vxlan_hdr *,
 264                                 l2_len + l3_len + l4_len);
 265                                 udp_port = RTE_BE_TO_CPU_16(udp_hdr->dst_port);
 266                                 vx_vni = rte_be_to_cpu_32(vxlan_hdr->vx_vni);
 267                                 MKDUMPSTR(print_buf, buf_size, cur_len,
 268                                           " - VXLAN packet: packet type =%d, "
 269                                           "Destination UDP port =%d, VNI = %d, "
 270                                           "last_rsvd = %d", packet_type,
 271                                           udp_port, vx_vni >> 8, vx_vni & 0xff);
 272                         }
 273                 }
 274                 MKDUMPSTR(print_buf, buf_size, cur_len,
 275                           " - %s queue=0x%x", is_rx ? "Receive" : "Send",
 276                           (unsigned int) queue);
 277                 MKDUMPSTR(print_buf, buf_size, cur_len, "\n");
 278                 if (is_rx)
 279                         rte_get_rx_ol_flag_list(mb->ol_flags, buf, sizeof(buf));
 280                 else
 281                         rte_get_tx_ol_flag_list(mb->ol_flags, buf, sizeof(buf));
 282
 283                 MKDUMPSTR(print_buf, buf_size, cur_len,
 284                           "  ol_flags: %s\n", buf);
 285                 if (rte_mbuf_check(mb, 1, &reason) < 0)
 286                         MKDUMPSTR(print_buf, buf_size, cur_len,
 287                                   "INVALID mbuf: %s\n", reason);
 288                 if (cur_len >= buf_size)
 289                         printf("%s ...\n", print_buf);
 290                 else
 291                         printf("%s", print_buf);
 292                 cur_len = 0;
 293         }
 294 }
 295
 296 uint16_t
 297 dump_rx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
 298              uint16_t nb_pkts, __rte_unused uint16_t max_pkts,
 299              __rte_unused void *user_param)
 300 {
 301         dump_pkt_burst(port_id, queue, pkts, nb_pkts, 1);
 302         return nb_pkts;
 303 }
 304
 305 uint16_t
 306 dump_tx_pkts(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
 307              uint16_t nb_pkts, __rte_unused void *user_param)
 308 {
 309         dump_pkt_burst(port_id, queue, pkts, nb_pkts, 0);
 310         return nb_pkts;
 311 }
 312
 313 uint16_t
 314 tx_pkt_set_md(uint16_t port_id, __rte_unused uint16_t queue,
 315               struct rte_mbuf *pkts[], uint16_t nb_pkts,
 316               __rte_unused void *user_param)
 317 {
 318         uint16_t i = 0;
 319
 320         /*
 321          * Add metadata value to every Tx packet,
 322          * and set ol_flags accordingly.
 323          */
 324         if (rte_flow_dynf_metadata_avail())
 325                 for (i = 0; i < nb_pkts; i++) {
 326                         *RTE_FLOW_DYNF_METADATA(pkts[i]) =
 327                                                 ports[port_id].tx_metadata;
 328                         pkts[i]->ol_flags |= PKT_TX_DYNF_METADATA;
 329                 }
 330         return nb_pkts;
 331 }
 332
 333 void
 334 add_tx_md_callback(portid_t portid)
 335 {
 336         struct rte_eth_dev_info dev_info;
 337         uint16_t queue;
 338         int ret;
 339
 340         if (port_id_is_invalid(portid, ENABLED_WARN))
 341                 return;
 342
 343         ret = eth_dev_info_get_print_err(portid, &dev_info);
 344         if (ret != 0)
 345                 return;
 346
 347         for (queue = 0; queue < dev_info.nb_tx_queues; queue++)
 348                 if (!ports[portid].tx_set_md_cb[queue])
 349                         ports[portid].tx_set_md_cb[queue] =
 350                                 rte_eth_add_tx_callback(portid, queue,
 351                                                         tx_pkt_set_md, NULL);
 352 }
 353
 354 void
 355 remove_tx_md_callback(portid_t portid)
 356 {
 357         struct rte_eth_dev_info dev_info;
 358         uint16_t queue;
 359         int ret;
 360
 361         if (port_id_is_invalid(portid, ENABLED_WARN))
 362                 return;
 363
 364         ret = eth_dev_info_get_print_err(portid, &dev_info);
 365         if (ret != 0)
 366                 return;
 367
 368         for (queue = 0; queue < dev_info.nb_tx_queues; queue++)
 369                 if (ports[portid].tx_set_md_cb[queue]) {
 370                         rte_eth_remove_tx_callback(portid, queue,
 371                                 ports[portid].tx_set_md_cb[queue]);
 372                         ports[portid].tx_set_md_cb[queue] = NULL;
 373                 }
 374 }
 375
 376 uint16_t
 377 tx_pkt_set_dynf(uint16_t port_id, __rte_unused uint16_t queue,
 378                 struct rte_mbuf *pkts[], uint16_t nb_pkts,
 379                 __rte_unused void *user_param)
 380 {
 381         uint16_t i = 0;
 382
 383         if (ports[port_id].mbuf_dynf)
 384                 for (i = 0; i < nb_pkts; i++)
 385                         pkts[i]->ol_flags |= ports[port_id].mbuf_dynf;
 386         return nb_pkts;
 387 }
 388
 389 void
 390 add_tx_dynf_callback(portid_t portid)
 391 {
 392         struct rte_eth_dev_info dev_info;
 393         uint16_t queue;
 394         int ret;
 395
 396         if (port_id_is_invalid(portid, ENABLED_WARN))
 397                 return;
 398
 399         ret = eth_dev_info_get_print_err(portid, &dev_info);
 400         if (ret != 0)
 401                 return;
 402
 403         for (queue = 0; queue < dev_info.nb_tx_queues; queue++)
 404                 if (!ports[portid].tx_set_dynf_cb[queue])
 405                         ports[portid].tx_set_dynf_cb[queue] =
 406                                 rte_eth_add_tx_callback(portid, queue,
 407                                                         tx_pkt_set_dynf, NULL);
 408 }
 409
 410 void
 411 remove_tx_dynf_callback(portid_t portid)
 412 {
 413         struct rte_eth_dev_info dev_info;
 414         uint16_t queue;
 415         int ret;
 416
 417         if (port_id_is_invalid(portid, ENABLED_WARN))
 418                 return;
 419
 420         ret = eth_dev_info_get_print_err(portid, &dev_info);
 421         if (ret != 0)
 422                 return;
 423
 424         for (queue = 0; queue < dev_info.nb_tx_queues; queue++)
 425                 if (ports[portid].tx_set_dynf_cb[queue]) {
 426                         rte_eth_remove_tx_callback(portid, queue,
 427                                 ports[portid].tx_set_dynf_cb[queue]);
 428                         ports[portid].tx_set_dynf_cb[queue] = NULL;
 429                 }
 430 }
 431
 432 int
 433 eth_dev_info_get_print_err(uint16_t port_id,
 434                                         struct rte_eth_dev_info *dev_info)
 435 {
 436         int ret;
 437
 438         ret = rte_eth_dev_info_get(port_id, dev_info);
 439         if (ret != 0)
 440                 fprintf(stderr,
 441                         "Error during getting device (port %u) info: %s\n",
 442                         port_id, strerror(-ret));
 443
 444         return ret;
 445 }
 446
 447 void
 448 eth_set_promisc_mode(uint16_t port, int enable)
 449 {
 450         int ret;
 451
 452         if (enable)
 453                 ret = rte_eth_promiscuous_enable(port);
 454         else
 455                 ret = rte_eth_promiscuous_disable(port);
 456
 457         if (ret != 0)
 458                 fprintf(stderr,
 459                         "Error during %s promiscuous mode for port %u: %s\n",
 460                         enable ? "enabling" : "disabling",
 461                         port, rte_strerror(-ret));
 462 }
 463
 464 void
 465 eth_set_allmulticast_mode(uint16_t port, int enable)
 466 {
 467         int ret;
 468
 469         if (enable)
 470                 ret = rte_eth_allmulticast_enable(port);
 471         else
 472                 ret = rte_eth_allmulticast_disable(port);
 473
 474         if (ret != 0)
 475                 fprintf(stderr,
 476                         "Error during %s all-multicast mode for port %u: %s\n",
 477                         enable ? "enabling" : "disabling",
 478                         port, rte_strerror(-ret));
 479 }
 480
 481 int
 482 eth_link_get_nowait_print_err(uint16_t port_id, struct rte_eth_link *link)
 483 {
 484         int ret;
 485
 486         ret = rte_eth_link_get_nowait(port_id, link);
 487         if (ret < 0)
 488                 fprintf(stderr,
 489                         "Device (port %u) link get (without wait) failed: %s\n",
 490                         port_id, rte_strerror(-ret));
 491
 492         return ret;
 493 }
 494
 495 int
 496 eth_macaddr_get_print_err(uint16_t port_id, struct rte_ether_addr *mac_addr)
 497 {
 498         int ret;
 499
 500         ret = rte_eth_macaddr_get(port_id, mac_addr);
 501         if (ret != 0)
 502                 fprintf(stderr,
 503                         "Error getting device (port %u) mac address: %s\n",
 504                         port_id, rte_strerror(-ret));
 505
 506         return ret;
 507 }