app/test-pmd/csumonly.c

   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 #include <stdarg.h>
  36 #include <stdio.h>
  37 #include <errno.h>
  38 #include <stdint.h>
  39 #include <unistd.h>
  40 #include <inttypes.h>
  41
  42 #include <sys/queue.h>
  43 #include <sys/stat.h>
  44
  45 #include <rte_common.h>
  46 #include <rte_byteorder.h>
  47 #include <rte_log.h>
  48 #include <rte_debug.h>
  49 #include <rte_cycles.h>
  50 #include <rte_memory.h>
  51 #include <rte_memcpy.h>
  52 #include <rte_memzone.h>
  53 #include <rte_launch.h>
  54 #include <rte_tailq.h>
  55 #include <rte_eal.h>
  56 #include <rte_per_lcore.h>
  57 #include <rte_lcore.h>
  58 #include <rte_atomic.h>
  59 #include <rte_branch_prediction.h>
  60 #include <rte_ring.h>
  61 #include <rte_memory.h>
  62 #include <rte_mempool.h>
  63 #include <rte_mbuf.h>
  64 #include <rte_memcpy.h>
  65 #include <rte_interrupts.h>
  66 #include <rte_pci.h>
  67 #include <rte_ether.h>
  68 #include <rte_ethdev.h>
  69 #include <rte_ip.h>
  70 #include <rte_tcp.h>
  71 #include <rte_udp.h>
  72 #include <rte_sctp.h>
  73 #include <rte_prefetch.h>
  74 #include <rte_string_fns.h>
  75 #include "testpmd.h"
  76
  77
  78
  79 #define IP_DEFTTL  64   /* from RFC 1340. */
  80 #define IP_VERSION 0x40
  81 #define IP_HDRLEN  0x05 /* default IP header length == five 32-bits words. */
  82 #define IP_VHL_DEF (IP_VERSION | IP_HDRLEN)
  83
  84 /* Pseudo Header for IPv4/UDP/TCP checksum */
  85 struct psd_header {
  86         uint32_t src_addr; /* IP address of source host. */
  87         uint32_t dst_addr; /* IP address of destination host(s). */
  88         uint8_t  zero;     /* zero. */
  89         uint8_t  proto;    /* L4 protocol type. */
  90         uint16_t len;      /* L4 length. */
  91 } __attribute__((__packed__));
  92
  93
  94 /* Pseudo Header for IPv6/UDP/TCP checksum */
  95 struct ipv6_psd_header {
  96         uint8_t src_addr[16]; /* IP address of source host. */
  97         uint8_t dst_addr[16]; /* IP address of destination host(s). */
  98         uint32_t len;         /* L4 length. */
  99         uint8_t  zero[3];     /* zero. */
 100         uint8_t  proto;       /* L4 protocol. */
 101 } __attribute__((__packed__));
 102
 103
 104 static inline uint16_t
 105 get_16b_sum(uint16_t *ptr16, uint32_t nr)
 106 {
 107         uint32_t sum = 0;
 108         while (nr > 1)
 109         {
 110                 sum +=*ptr16;
 111                 nr -= sizeof(uint16_t);
 112                 ptr16++;
 113                 if (sum > UINT16_MAX)
 114                         sum -= UINT16_MAX;
 115         }
 116
 117         /* If length is in odd bytes */
 118         if (nr)
 119                 sum += *((uint8_t*)ptr16);
 120
 121         sum = ((sum & 0xffff0000) >> 16) + (sum & 0xffff);
 122         sum &= 0x0ffff;
 123         return (uint16_t)sum;
 124 }
 125
 126 static inline uint16_t
 127 get_ipv4_cksum(struct ipv4_hdr *ipv4_hdr)
 128 {
 129         uint16_t cksum;
 130         cksum = get_16b_sum((uint16_t*)ipv4_hdr, sizeof(struct ipv4_hdr));
 131         return (uint16_t)((cksum == 0xffff)?cksum:~cksum);
 132 }
 133
 134
 135 static inline
 136 uint16_t get_ipv4_psd_sum (struct ipv4_hdr * ip_hdr)
 137 {
 138         struct psd_header psd_hdr;
 139         psd_hdr.src_addr = ip_hdr->src_addr;
 140         psd_hdr.dst_addr = ip_hdr->dst_addr;
 141         psd_hdr.zero     = 0;
 142         psd_hdr.proto    = ip_hdr->next_proto_id;
 143         psd_hdr.len      = rte_cpu_to_be_16((uint16_t)(rte_be_to_cpu_16(ip_hdr->total_length)
 144                                 - sizeof(struct ipv4_hdr)));
 145         return get_16b_sum((uint16_t*)&psd_hdr, sizeof(struct psd_header));
 146 }
 147
 148 static inline
 149 uint16_t get_ipv6_psd_sum (struct ipv6_hdr * ip_hdr)
 150 {
 151         struct ipv6_psd_header psd_hdr;
 152         rte_memcpy(psd_hdr.src_addr, ip_hdr->src_addr, sizeof(ip_hdr->src_addr)
 153                         + sizeof(ip_hdr->dst_addr));
 154
 155         psd_hdr.zero[0]   = 0;
 156         psd_hdr.zero[1]   = 0;
 157         psd_hdr.zero[2]   = 0;
 158         psd_hdr.proto     = ip_hdr->proto;
 159         psd_hdr.len       = ip_hdr->payload_len;
 160
 161         return get_16b_sum((uint16_t*)&psd_hdr, sizeof(struct ipv6_psd_header));
 162 }
 163
 164 static inline uint16_t
 165 get_ipv4_udptcp_checksum(struct ipv4_hdr *ipv4_hdr, uint16_t *l4_hdr)
 166 {
 167         uint32_t cksum;
 168         uint32_t l4_len;
 169
 170         l4_len = rte_be_to_cpu_16(ipv4_hdr->total_length) - sizeof(struct ipv4_hdr);
 171
 172         cksum = get_16b_sum(l4_hdr, l4_len);
 173         cksum += get_ipv4_psd_sum(ipv4_hdr);
 174
 175         cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
 176         cksum = (~cksum) & 0xffff;
 177         if (cksum == 0)
 178                 cksum = 0xffff;
 179         return (uint16_t)cksum;
 180
 181 }
 182
 183 static inline uint16_t
 184 get_ipv6_udptcp_checksum(struct ipv6_hdr *ipv6_hdr, uint16_t *l4_hdr)
 185 {
 186         uint32_t cksum;
 187         uint32_t l4_len;
 188
 189         l4_len = rte_be_to_cpu_16(ipv6_hdr->payload_len);
 190
 191         cksum = get_16b_sum(l4_hdr, l4_len);
 192         cksum += get_ipv6_psd_sum(ipv6_hdr);
 193
 194         cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
 195         cksum = (~cksum) & 0xffff;
 196         if (cksum == 0)
 197                 cksum = 0xffff;
 198
 199         return (uint16_t)cksum;
 200 }
 201
 202
 203 /*
 204  * Forwarding of packets. Change the checksum field with HW or SW methods
 205  * The HW/SW method selection depends on the ol_flags on every packet
 206  */
 207 static void
 208 pkt_burst_checksum_forward(struct fwd_stream *fs)
 209 {
 210         struct rte_mbuf  *pkts_burst[MAX_PKT_BURST];
 211         struct rte_port  *txp;
 212         struct rte_mbuf  *mb;
 213         struct ether_hdr *eth_hdr;
 214         struct ipv4_hdr  *ipv4_hdr;
 215         struct ipv6_hdr  *ipv6_hdr;
 216         struct udp_hdr   *udp_hdr;
 217         struct tcp_hdr   *tcp_hdr;
 218         struct sctp_hdr  *sctp_hdr;
 219
 220         uint16_t nb_rx;
 221         uint16_t nb_tx;
 222         uint16_t i;
 223         uint16_t ol_flags;
 224         uint16_t pkt_ol_flags;
 225         uint16_t tx_ol_flags;
 226         uint16_t l4_proto;
 227         uint8_t  l2_len;
 228         uint8_t  l3_len;
 229
 230         uint32_t rx_bad_ip_csum;
 231         uint32_t rx_bad_l4_csum;
 232
 233 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
 234         uint64_t start_tsc;
 235         uint64_t end_tsc;
 236         uint64_t core_cycles;
 237 #endif
 238
 239 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
 240         start_tsc = rte_rdtsc();
 241 #endif
 242
 243         /*
 244          * Receive a burst of packets and forward them.
 245          */
 246         nb_rx = rte_eth_rx_burst(fs->rx_port, fs->rx_queue, pkts_burst,
 247                                  nb_pkt_per_burst);
 248         if (unlikely(nb_rx == 0))
 249                 return;
 250
 251 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
 252         fs->rx_burst_stats.pkt_burst_spread[nb_rx]++;
 253 #endif
 254         fs->rx_packets += nb_rx;
 255         rx_bad_ip_csum = 0;
 256         rx_bad_l4_csum = 0;
 257
 258         txp = &ports[fs->tx_port];
 259         tx_ol_flags = txp->tx_ol_flags;
 260
 261         for (i = 0; i < nb_rx; i++) {
 262
 263                 mb = pkts_burst[i];
 264                 l2_len  = sizeof(struct ether_hdr);
 265                 pkt_ol_flags = mb->ol_flags;
 266                 ol_flags = (uint16_t) (pkt_ol_flags & (~PKT_TX_L4_MASK));
 267
 268                 eth_hdr = (struct ether_hdr *) mb->pkt.data;
 269                 if (rte_be_to_cpu_16(eth_hdr->ether_type) == ETHER_TYPE_VLAN) {
 270                         /* Only allow single VLAN label here */
 271                         l2_len  += sizeof(struct vlan_hdr);
 272                 }
 273
 274                 /* Update the L3/L4 checksum error packet count  */
 275                 rx_bad_ip_csum += (uint16_t) ((pkt_ol_flags & PKT_RX_IP_CKSUM_BAD) != 0);
 276                 rx_bad_l4_csum += (uint16_t) ((pkt_ol_flags & PKT_RX_L4_CKSUM_BAD) != 0);
 277
 278                 /*
 279                  * Simplify the protocol parsing
 280                  * Assuming the incoming packets format as
 281                  *      Ethernet2 + optional single VLAN
 282                  *      + ipv4 or ipv6
 283                  *      + udp or tcp or sctp or others
 284                  */
 285                 if (pkt_ol_flags & PKT_RX_IPV4_HDR) {
 286
 287                         /* Do not support ipv4 option field */
 288                         l3_len = sizeof(struct ipv4_hdr) ;
 289
 290                         ipv4_hdr = (struct ipv4_hdr *) (rte_pktmbuf_mtod(mb,
 291                                         unsigned char *) + l2_len);
 292
 293                         l4_proto = ipv4_hdr->next_proto_id;
 294
 295                         /* Do not delete, this is required by HW*/
 296                         ipv4_hdr->hdr_checksum = 0;
 297
 298                         if (tx_ol_flags & 0x1) {
 299                                 /* HW checksum */
 300                                 ol_flags |= PKT_TX_IP_CKSUM;
 301                         }
 302                         else {
 303                                 /* SW checksum calculation */
 304                                 ipv4_hdr->src_addr++;
 305                                 ipv4_hdr->hdr_checksum = get_ipv4_cksum(ipv4_hdr);
 306                         }
 307
 308                         if (l4_proto == IPPROTO_UDP) {
 309                                 udp_hdr = (struct udp_hdr*) (rte_pktmbuf_mtod(mb,
 310                                                 unsigned char *) + l2_len + l3_len);
 311                                 if (tx_ol_flags & 0x2) {
 312                                         /* HW Offload */
 313                                         ol_flags |= PKT_TX_UDP_CKSUM;
 314                                         /* Pseudo header sum need be set properly */
 315                                         udp_hdr->dgram_cksum = get_ipv4_psd_sum(ipv4_hdr);
 316                                 }
 317                                 else {
 318                                         /* SW Implementation, clear checksum field first */
 319                                         udp_hdr->dgram_cksum = 0;
 320                                         udp_hdr->dgram_cksum = get_ipv4_udptcp_checksum(ipv4_hdr,
 321                                                         (uint16_t*)udp_hdr);
 322                                 }
 323                         }
 324                         else if (l4_proto == IPPROTO_TCP){
 325                                 tcp_hdr = (struct tcp_hdr*) (rte_pktmbuf_mtod(mb,
 326                                                 unsigned char *) + l2_len + l3_len);
 327                                 if (tx_ol_flags & 0x4) {
 328                                         ol_flags |= PKT_TX_TCP_CKSUM;
 329                                         tcp_hdr->cksum = get_ipv4_psd_sum(ipv4_hdr);
 330                                 }
 331                                 else {
 332                                         tcp_hdr->cksum = 0;
 333                                         tcp_hdr->cksum = get_ipv4_udptcp_checksum(ipv4_hdr,
 334                                                         (uint16_t*)tcp_hdr);
 335                                 }
 336                         }
 337                         else if (l4_proto == IPPROTO_SCTP) {
 338                                 sctp_hdr = (struct sctp_hdr*) (rte_pktmbuf_mtod(mb,
 339                                                 unsigned char *) + l2_len + l3_len);
 340
 341                                 if (tx_ol_flags & 0x8) {
 342                                         ol_flags |= PKT_TX_SCTP_CKSUM;
 343                                         sctp_hdr->cksum = 0;
 344
 345                                         /* Sanity check, only number of 4 bytes supported */
 346                                         if ((rte_be_to_cpu_16(ipv4_hdr->total_length) % 4) != 0)
 347                                                 printf("sctp payload must be a multiple "
 348                                                         "of 4 bytes for checksum offload");
 349                                 }
 350                                 else {
 351                                         sctp_hdr->cksum = 0;
 352                                         /* CRC32c sample code available in RFC3309 */
 353                                 }
 354                         }
 355                         /* End of L4 Handling*/
 356                 }
 357
 358                 else {
 359                         ipv6_hdr = (struct ipv6_hdr *) (rte_pktmbuf_mtod(mb,
 360                                         unsigned char *) + l2_len);
 361                         l3_len = sizeof(struct ipv6_hdr) ;
 362                         l4_proto = ipv6_hdr->proto;
 363
 364                         if (l4_proto == IPPROTO_UDP) {
 365                                 udp_hdr = (struct udp_hdr*) (rte_pktmbuf_mtod(mb,
 366                                                 unsigned char *) + l2_len + l3_len);
 367                                 if (tx_ol_flags & 0x2) {
 368                                         /* HW Offload */
 369                                         ol_flags |= PKT_TX_UDP_CKSUM;
 370                                         udp_hdr->dgram_cksum = get_ipv6_psd_sum(ipv6_hdr);
 371                                 }
 372                                 else {
 373                                         /* SW Implementation */
 374                                         /* checksum field need be clear first */
 375                                         udp_hdr->dgram_cksum = 0;
 376                                         udp_hdr->dgram_cksum = get_ipv6_udptcp_checksum(ipv6_hdr,
 377                                                         (uint16_t*)udp_hdr);
 378                                 }
 379                         }
 380                         else if (l4_proto == IPPROTO_TCP) {
 381                                 tcp_hdr = (struct tcp_hdr*) (rte_pktmbuf_mtod(mb,
 382                                                 unsigned char *) + l2_len + l3_len);
 383                                 if (tx_ol_flags & 0x4) {
 384                                         ol_flags |= PKT_TX_TCP_CKSUM;
 385                                         tcp_hdr->cksum = get_ipv6_psd_sum(ipv6_hdr);
 386                                 }
 387                                 else {
 388                                         tcp_hdr->cksum = 0;
 389                                         tcp_hdr->cksum = get_ipv6_udptcp_checksum(ipv6_hdr,
 390                                                         (uint16_t*)tcp_hdr);
 391                                 }
 392                         }
 393                         else if (l4_proto == IPPROTO_SCTP) {
 394                                 sctp_hdr = (struct sctp_hdr*) (rte_pktmbuf_mtod(mb,
 395                                                 unsigned char *) + l2_len + l3_len);
 396
 397                                 if (tx_ol_flags & 0x8) {
 398                                         ol_flags |= PKT_TX_SCTP_CKSUM;
 399                                         sctp_hdr->cksum = 0;
 400                                         /* Sanity check, only number of 4 bytes supported by HW */
 401                                         if ((rte_be_to_cpu_16(ipv6_hdr->payload_len) % 4) != 0)
 402                                                 printf("sctp payload must be a multiple "
 403                                                         "of 4 bytes for checksum offload");
 404                                 }
 405                                 else {
 406                                         /* CRC32c sample code available in RFC3309 */
 407                                         sctp_hdr->cksum = 0;
 408                                 }
 409                         } else {
 410                                 printf("Test flow control for 1G PMD \n");
 411                         }
 412                         /* End of L4 Handling*/
 413                 }
 414
 415                 /* Combine the packet header write. VLAN is not consider here */
 416                 mb->pkt.l2_len = l2_len;
 417                 mb->pkt.l3_len = l3_len;
 418                 mb->ol_flags = ol_flags;
 419         }
 420         nb_tx = rte_eth_tx_burst(fs->tx_port, fs->tx_queue, pkts_burst, nb_rx);
 421         fs->tx_packets += nb_tx;
 422         fs->rx_bad_ip_csum += rx_bad_ip_csum;
 423         fs->rx_bad_l4_csum += rx_bad_l4_csum;
 424
 425 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
 426         fs->tx_burst_stats.pkt_burst_spread[nb_tx]++;
 427 #endif
 428         if (unlikely(nb_tx < nb_rx)) {
 429                 fs->fwd_dropped += (nb_rx - nb_tx);
 430                 do {
 431                         rte_pktmbuf_free(pkts_burst[nb_tx]);
 432                 } while (++nb_tx < nb_rx);
 433         }
 434 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
 435         end_tsc = rte_rdtsc();
 436         core_cycles = (end_tsc - start_tsc);
 437         fs->core_cycles = (uint64_t) (fs->core_cycles + core_cycles);
 438 #endif
 439 }
 440
 441
 442 struct fwd_engine csum_fwd_engine = {
 443         .fwd_mode_name  = "csum",
 444         .port_fwd_begin = NULL,
 445         .port_fwd_end   = NULL,
 446         .packet_fwd     = pkt_burst_checksum_forward,
 447 };
 448