app/testpmd: do not change IP addrs in checksum engine
[dpdk.git] / app / test-pmd / csumonly.c
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   Copyright 2014 6WIND S.A.
6  *   All rights reserved.
7  *
8  *   Redistribution and use in source and binary forms, with or without
9  *   modification, are permitted provided that the following conditions
10  *   are met:
11  *
12  *     * Redistributions of source code must retain the above copyright
13  *       notice, this list of conditions and the following disclaimer.
14  *     * Redistributions in binary form must reproduce the above copyright
15  *       notice, this list of conditions and the following disclaimer in
16  *       the documentation and/or other materials provided with the
17  *       distribution.
18  *     * Neither the name of Intel Corporation nor the names of its
19  *       contributors may be used to endorse or promote products derived
20  *       from this software without specific prior written permission.
21  *
22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
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_eal.h>
55 #include <rte_per_lcore.h>
56 #include <rte_lcore.h>
57 #include <rte_atomic.h>
58 #include <rte_branch_prediction.h>
59 #include <rte_memory.h>
60 #include <rte_mempool.h>
61 #include <rte_mbuf.h>
62 #include <rte_memcpy.h>
63 #include <rte_interrupts.h>
64 #include <rte_pci.h>
65 #include <rte_ether.h>
66 #include <rte_ethdev.h>
67 #include <rte_ip.h>
68 #include <rte_tcp.h>
69 #include <rte_udp.h>
70 #include <rte_sctp.h>
71 #include <rte_prefetch.h>
72 #include <rte_string_fns.h>
73 #include "testpmd.h"
74
75 #define IP_DEFTTL  64   /* from RFC 1340. */
76 #define IP_VERSION 0x40
77 #define IP_HDRLEN  0x05 /* default IP header length == five 32-bits words. */
78 #define IP_VHL_DEF (IP_VERSION | IP_HDRLEN)
79
80 #define GRE_KEY_PRESENT 0x2000
81 #define GRE_KEY_LEN     4
82 #define GRE_SUPPORTED_FIELDS GRE_KEY_PRESENT
83
84 /* We cannot use rte_cpu_to_be_16() on a constant in a switch/case */
85 #if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
86 #define _htons(x) ((uint16_t)((((x) & 0x00ffU) << 8) | (((x) & 0xff00U) >> 8)))
87 #else
88 #define _htons(x) (x)
89 #endif
90
91 /* structure that caches offload info for the current packet */
92 struct testpmd_offload_info {
93         uint16_t ethertype;
94         uint16_t l2_len;
95         uint16_t l3_len;
96         uint16_t l4_len;
97         uint8_t l4_proto;
98         uint8_t is_tunnel;
99         uint16_t outer_ethertype;
100         uint16_t outer_l2_len;
101         uint16_t outer_l3_len;
102         uint8_t outer_l4_proto;
103         uint16_t tso_segsz;
104         uint16_t tunnel_tso_segsz;
105 };
106
107 /* simplified GRE header */
108 struct simple_gre_hdr {
109         uint16_t flags;
110         uint16_t proto;
111 } __attribute__((__packed__));
112
113 static uint16_t
114 get_psd_sum(void *l3_hdr, uint16_t ethertype, uint64_t ol_flags)
115 {
116         if (ethertype == _htons(ETHER_TYPE_IPv4))
117                 return rte_ipv4_phdr_cksum(l3_hdr, ol_flags);
118         else /* assume ethertype == ETHER_TYPE_IPv6 */
119                 return rte_ipv6_phdr_cksum(l3_hdr, ol_flags);
120 }
121
122 static uint16_t
123 get_udptcp_checksum(void *l3_hdr, void *l4_hdr, uint16_t ethertype)
124 {
125         if (ethertype == _htons(ETHER_TYPE_IPv4))
126                 return rte_ipv4_udptcp_cksum(l3_hdr, l4_hdr);
127         else /* assume ethertype == ETHER_TYPE_IPv6 */
128                 return rte_ipv6_udptcp_cksum(l3_hdr, l4_hdr);
129 }
130
131 /* Parse an IPv4 header to fill l3_len, l4_len, and l4_proto */
132 static void
133 parse_ipv4(struct ipv4_hdr *ipv4_hdr, struct testpmd_offload_info *info)
134 {
135         struct tcp_hdr *tcp_hdr;
136
137         info->l3_len = (ipv4_hdr->version_ihl & 0x0f) * 4;
138         info->l4_proto = ipv4_hdr->next_proto_id;
139
140         /* only fill l4_len for TCP, it's useful for TSO */
141         if (info->l4_proto == IPPROTO_TCP) {
142                 tcp_hdr = (struct tcp_hdr *)((char *)ipv4_hdr + info->l3_len);
143                 info->l4_len = (tcp_hdr->data_off & 0xf0) >> 2;
144         } else
145                 info->l4_len = 0;
146 }
147
148 /* Parse an IPv6 header to fill l3_len, l4_len, and l4_proto */
149 static void
150 parse_ipv6(struct ipv6_hdr *ipv6_hdr, struct testpmd_offload_info *info)
151 {
152         struct tcp_hdr *tcp_hdr;
153
154         info->l3_len = sizeof(struct ipv6_hdr);
155         info->l4_proto = ipv6_hdr->proto;
156
157         /* only fill l4_len for TCP, it's useful for TSO */
158         if (info->l4_proto == IPPROTO_TCP) {
159                 tcp_hdr = (struct tcp_hdr *)((char *)ipv6_hdr + info->l3_len);
160                 info->l4_len = (tcp_hdr->data_off & 0xf0) >> 2;
161         } else
162                 info->l4_len = 0;
163 }
164
165 /*
166  * Parse an ethernet header to fill the ethertype, l2_len, l3_len and
167  * ipproto. This function is able to recognize IPv4/IPv6 with one optional vlan
168  * header. The l4_len argument is only set in case of TCP (useful for TSO).
169  */
170 static void
171 parse_ethernet(struct ether_hdr *eth_hdr, struct testpmd_offload_info *info)
172 {
173         struct ipv4_hdr *ipv4_hdr;
174         struct ipv6_hdr *ipv6_hdr;
175
176         info->l2_len = sizeof(struct ether_hdr);
177         info->ethertype = eth_hdr->ether_type;
178
179         if (info->ethertype == _htons(ETHER_TYPE_VLAN)) {
180                 struct vlan_hdr *vlan_hdr = (struct vlan_hdr *)(eth_hdr + 1);
181
182                 info->l2_len  += sizeof(struct vlan_hdr);
183                 info->ethertype = vlan_hdr->eth_proto;
184         }
185
186         switch (info->ethertype) {
187         case _htons(ETHER_TYPE_IPv4):
188                 ipv4_hdr = (struct ipv4_hdr *) ((char *)eth_hdr + info->l2_len);
189                 parse_ipv4(ipv4_hdr, info);
190                 break;
191         case _htons(ETHER_TYPE_IPv6):
192                 ipv6_hdr = (struct ipv6_hdr *) ((char *)eth_hdr + info->l2_len);
193                 parse_ipv6(ipv6_hdr, info);
194                 break;
195         default:
196                 info->l4_len = 0;
197                 info->l3_len = 0;
198                 info->l4_proto = 0;
199                 break;
200         }
201 }
202
203 /* Parse a vxlan header */
204 static void
205 parse_vxlan(struct udp_hdr *udp_hdr,
206             struct testpmd_offload_info *info,
207             uint32_t pkt_type)
208 {
209         struct ether_hdr *eth_hdr;
210
211         /* check udp destination port, 4789 is the default vxlan port
212          * (rfc7348) or that the rx offload flag is set (i40e only
213          * currently) */
214         if (udp_hdr->dst_port != _htons(4789) &&
215                 RTE_ETH_IS_TUNNEL_PKT(pkt_type) == 0)
216                 return;
217
218         info->is_tunnel = 1;
219         info->outer_ethertype = info->ethertype;
220         info->outer_l2_len = info->l2_len;
221         info->outer_l3_len = info->l3_len;
222         info->outer_l4_proto = info->l4_proto;
223
224         eth_hdr = (struct ether_hdr *)((char *)udp_hdr +
225                 sizeof(struct udp_hdr) +
226                 sizeof(struct vxlan_hdr));
227
228         parse_ethernet(eth_hdr, info);
229         info->l2_len += ETHER_VXLAN_HLEN; /* add udp + vxlan */
230 }
231
232 /* Parse a gre header */
233 static void
234 parse_gre(struct simple_gre_hdr *gre_hdr, struct testpmd_offload_info *info)
235 {
236         struct ether_hdr *eth_hdr;
237         struct ipv4_hdr *ipv4_hdr;
238         struct ipv6_hdr *ipv6_hdr;
239         uint8_t gre_len = 0;
240
241         /* check which fields are supported */
242         if ((gre_hdr->flags & _htons(~GRE_SUPPORTED_FIELDS)) != 0)
243                 return;
244
245         gre_len += sizeof(struct simple_gre_hdr);
246
247         if (gre_hdr->flags & _htons(GRE_KEY_PRESENT))
248                 gre_len += GRE_KEY_LEN;
249
250         if (gre_hdr->proto == _htons(ETHER_TYPE_IPv4)) {
251                 info->is_tunnel = 1;
252                 info->outer_ethertype = info->ethertype;
253                 info->outer_l2_len = info->l2_len;
254                 info->outer_l3_len = info->l3_len;
255                 info->outer_l4_proto = info->l4_proto;
256
257                 ipv4_hdr = (struct ipv4_hdr *)((char *)gre_hdr + gre_len);
258
259                 parse_ipv4(ipv4_hdr, info);
260                 info->ethertype = _htons(ETHER_TYPE_IPv4);
261                 info->l2_len = 0;
262
263         } else if (gre_hdr->proto == _htons(ETHER_TYPE_IPv6)) {
264                 info->is_tunnel = 1;
265                 info->outer_ethertype = info->ethertype;
266                 info->outer_l2_len = info->l2_len;
267                 info->outer_l3_len = info->l3_len;
268                 info->outer_l4_proto = info->l4_proto;
269
270                 ipv6_hdr = (struct ipv6_hdr *)((char *)gre_hdr + gre_len);
271
272                 info->ethertype = _htons(ETHER_TYPE_IPv6);
273                 parse_ipv6(ipv6_hdr, info);
274                 info->l2_len = 0;
275
276         } else if (gre_hdr->proto == _htons(ETHER_TYPE_TEB)) {
277                 info->is_tunnel = 1;
278                 info->outer_ethertype = info->ethertype;
279                 info->outer_l2_len = info->l2_len;
280                 info->outer_l3_len = info->l3_len;
281                 info->outer_l4_proto = info->l4_proto;
282
283                 eth_hdr = (struct ether_hdr *)((char *)gre_hdr + gre_len);
284
285                 parse_ethernet(eth_hdr, info);
286         } else
287                 return;
288
289         info->l2_len += gre_len;
290 }
291
292
293 /* Parse an encapsulated ip or ipv6 header */
294 static void
295 parse_encap_ip(void *encap_ip, struct testpmd_offload_info *info)
296 {
297         struct ipv4_hdr *ipv4_hdr = encap_ip;
298         struct ipv6_hdr *ipv6_hdr = encap_ip;
299         uint8_t ip_version;
300
301         ip_version = (ipv4_hdr->version_ihl & 0xf0) >> 4;
302
303         if (ip_version != 4 && ip_version != 6)
304                 return;
305
306         info->is_tunnel = 1;
307         info->outer_ethertype = info->ethertype;
308         info->outer_l2_len = info->l2_len;
309         info->outer_l3_len = info->l3_len;
310
311         if (ip_version == 4) {
312                 parse_ipv4(ipv4_hdr, info);
313                 info->ethertype = _htons(ETHER_TYPE_IPv4);
314         } else {
315                 parse_ipv6(ipv6_hdr, info);
316                 info->ethertype = _htons(ETHER_TYPE_IPv6);
317         }
318         info->l2_len = 0;
319 }
320
321 /* if possible, calculate the checksum of a packet in hw or sw,
322  * depending on the testpmd command line configuration */
323 static uint64_t
324 process_inner_cksums(void *l3_hdr, const struct testpmd_offload_info *info,
325         uint16_t testpmd_ol_flags)
326 {
327         struct ipv4_hdr *ipv4_hdr = l3_hdr;
328         struct udp_hdr *udp_hdr;
329         struct tcp_hdr *tcp_hdr;
330         struct sctp_hdr *sctp_hdr;
331         uint64_t ol_flags = 0;
332
333         if (info->ethertype == _htons(ETHER_TYPE_IPv4)) {
334                 ipv4_hdr = l3_hdr;
335                 ipv4_hdr->hdr_checksum = 0;
336
337                 ol_flags |= PKT_TX_IPV4;
338                 if (info->l4_proto == IPPROTO_TCP &&
339                     ((info->is_tunnel && info->tunnel_tso_segsz != 0) ||
340                      (!info->is_tunnel && info->tso_segsz != 0))) {
341                         ol_flags |= PKT_TX_IP_CKSUM;
342                 } else {
343                         if (testpmd_ol_flags & TESTPMD_TX_OFFLOAD_IP_CKSUM)
344                                 ol_flags |= PKT_TX_IP_CKSUM;
345                         else
346                                 ipv4_hdr->hdr_checksum =
347                                         rte_ipv4_cksum(ipv4_hdr);
348                 }
349         } else if (info->ethertype == _htons(ETHER_TYPE_IPv6))
350                 ol_flags |= PKT_TX_IPV6;
351         else
352                 return 0; /* packet type not supported, nothing to do */
353
354         if (info->l4_proto == IPPROTO_UDP) {
355                 udp_hdr = (struct udp_hdr *)((char *)l3_hdr + info->l3_len);
356                 /* do not recalculate udp cksum if it was 0 */
357                 if (udp_hdr->dgram_cksum != 0) {
358                         udp_hdr->dgram_cksum = 0;
359                         if (testpmd_ol_flags & TESTPMD_TX_OFFLOAD_UDP_CKSUM) {
360                                 ol_flags |= PKT_TX_UDP_CKSUM;
361                                 udp_hdr->dgram_cksum = get_psd_sum(l3_hdr,
362                                         info->ethertype, ol_flags);
363                         } else {
364                                 udp_hdr->dgram_cksum =
365                                         get_udptcp_checksum(l3_hdr, udp_hdr,
366                                                 info->ethertype);
367                         }
368                 }
369         } else if (info->l4_proto == IPPROTO_TCP) {
370                 tcp_hdr = (struct tcp_hdr *)((char *)l3_hdr + info->l3_len);
371                 tcp_hdr->cksum = 0;
372                 if ((info->is_tunnel && info->tunnel_tso_segsz != 0) ||
373                     (!info->is_tunnel && info->tso_segsz != 0)) {
374                         ol_flags |= PKT_TX_TCP_SEG;
375                         tcp_hdr->cksum = get_psd_sum(l3_hdr, info->ethertype,
376                                 ol_flags);
377                 } else if (testpmd_ol_flags & TESTPMD_TX_OFFLOAD_TCP_CKSUM) {
378                         ol_flags |= PKT_TX_TCP_CKSUM;
379                         tcp_hdr->cksum = get_psd_sum(l3_hdr, info->ethertype,
380                                 ol_flags);
381                 } else {
382                         tcp_hdr->cksum =
383                                 get_udptcp_checksum(l3_hdr, tcp_hdr,
384                                         info->ethertype);
385                 }
386         } else if (info->l4_proto == IPPROTO_SCTP) {
387                 sctp_hdr = (struct sctp_hdr *)((char *)l3_hdr + info->l3_len);
388                 sctp_hdr->cksum = 0;
389                 /* sctp payload must be a multiple of 4 to be
390                  * offloaded */
391                 if ((testpmd_ol_flags & TESTPMD_TX_OFFLOAD_SCTP_CKSUM) &&
392                         ((ipv4_hdr->total_length & 0x3) == 0)) {
393                         ol_flags |= PKT_TX_SCTP_CKSUM;
394                 } else {
395                         /* XXX implement CRC32c, example available in
396                          * RFC3309 */
397                 }
398         }
399
400         return ol_flags;
401 }
402
403 /* Calculate the checksum of outer header */
404 static uint64_t
405 process_outer_cksums(void *outer_l3_hdr, struct testpmd_offload_info *info,
406         uint16_t testpmd_ol_flags, int tso_enabled)
407 {
408         struct ipv4_hdr *ipv4_hdr = outer_l3_hdr;
409         struct ipv6_hdr *ipv6_hdr = outer_l3_hdr;
410         struct udp_hdr *udp_hdr;
411         uint64_t ol_flags = 0;
412
413         if (info->outer_ethertype == _htons(ETHER_TYPE_IPv4)) {
414                 ipv4_hdr->hdr_checksum = 0;
415                 ol_flags |= PKT_TX_OUTER_IPV4;
416
417                 if (testpmd_ol_flags & TESTPMD_TX_OFFLOAD_OUTER_IP_CKSUM)
418                         ol_flags |= PKT_TX_OUTER_IP_CKSUM;
419                 else
420                         ipv4_hdr->hdr_checksum = rte_ipv4_cksum(ipv4_hdr);
421         } else if (testpmd_ol_flags & TESTPMD_TX_OFFLOAD_OUTER_IP_CKSUM)
422                 ol_flags |= PKT_TX_OUTER_IPV6;
423
424         if (info->outer_l4_proto != IPPROTO_UDP)
425                 return ol_flags;
426
427         udp_hdr = (struct udp_hdr *)((char *)outer_l3_hdr + info->outer_l3_len);
428
429         /* outer UDP checksum is done in software as we have no hardware
430          * supporting it today, and no API for it. In the other side, for
431          * UDP tunneling, like VXLAN or Geneve, outer UDP checksum can be
432          * set to zero.
433          *
434          * If a packet will be TSOed into small packets by NIC, we cannot
435          * set/calculate a non-zero checksum, because it will be a wrong
436          * value after the packet be split into several small packets.
437          */
438         if (tso_enabled)
439                 udp_hdr->dgram_cksum = 0;
440
441         /* do not recalculate udp cksum if it was 0 */
442         if (udp_hdr->dgram_cksum != 0) {
443                 udp_hdr->dgram_cksum = 0;
444                 if (info->outer_ethertype == _htons(ETHER_TYPE_IPv4))
445                         udp_hdr->dgram_cksum =
446                                 rte_ipv4_udptcp_cksum(ipv4_hdr, udp_hdr);
447                 else
448                         udp_hdr->dgram_cksum =
449                                 rte_ipv6_udptcp_cksum(ipv6_hdr, udp_hdr);
450         }
451
452         return ol_flags;
453 }
454
455 /*
456  * Helper function.
457  * Performs actual copying.
458  * Returns number of segments in the destination mbuf on success,
459  * or negative error code on failure.
460  */
461 static int
462 mbuf_copy_split(const struct rte_mbuf *ms, struct rte_mbuf *md[],
463         uint16_t seglen[], uint8_t nb_seg)
464 {
465         uint32_t dlen, slen, tlen;
466         uint32_t i, len;
467         const struct rte_mbuf *m;
468         const uint8_t *src;
469         uint8_t *dst;
470
471         dlen = 0;
472         slen = 0;
473         tlen = 0;
474
475         dst = NULL;
476         src = NULL;
477
478         m = ms;
479         i = 0;
480         while (ms != NULL && i != nb_seg) {
481
482                 if (slen == 0) {
483                         slen = rte_pktmbuf_data_len(ms);
484                         src = rte_pktmbuf_mtod(ms, const uint8_t *);
485                 }
486
487                 if (dlen == 0) {
488                         dlen = RTE_MIN(seglen[i], slen);
489                         md[i]->data_len = dlen;
490                         md[i]->next = (i + 1 == nb_seg) ? NULL : md[i + 1];
491                         dst = rte_pktmbuf_mtod(md[i], uint8_t *);
492                 }
493
494                 len = RTE_MIN(slen, dlen);
495                 memcpy(dst, src, len);
496                 tlen += len;
497                 slen -= len;
498                 dlen -= len;
499                 src += len;
500                 dst += len;
501
502                 if (slen == 0)
503                         ms = ms->next;
504                 if (dlen == 0)
505                         i++;
506         }
507
508         if (ms != NULL)
509                 return -ENOBUFS;
510         else if (tlen != m->pkt_len)
511                 return -EINVAL;
512
513         md[0]->nb_segs = nb_seg;
514         md[0]->pkt_len = tlen;
515         md[0]->vlan_tci = m->vlan_tci;
516         md[0]->vlan_tci_outer = m->vlan_tci_outer;
517         md[0]->ol_flags = m->ol_flags;
518         md[0]->tx_offload = m->tx_offload;
519
520         return nb_seg;
521 }
522
523 /*
524  * Allocate a new mbuf with up to tx_pkt_nb_segs segments.
525  * Copy packet contents and offload information into then new segmented mbuf.
526  */
527 static struct rte_mbuf *
528 pkt_copy_split(const struct rte_mbuf *pkt)
529 {
530         int32_t n, rc;
531         uint32_t i, len, nb_seg;
532         struct rte_mempool *mp;
533         uint16_t seglen[RTE_MAX_SEGS_PER_PKT];
534         struct rte_mbuf *p, *md[RTE_MAX_SEGS_PER_PKT];
535
536         mp = current_fwd_lcore()->mbp;
537
538         if (tx_pkt_split == TX_PKT_SPLIT_RND)
539                 nb_seg = random() % tx_pkt_nb_segs + 1;
540         else
541                 nb_seg = tx_pkt_nb_segs;
542
543         memcpy(seglen, tx_pkt_seg_lengths, nb_seg * sizeof(seglen[0]));
544
545         /* calculate number of segments to use and their length. */
546         len = 0;
547         for (i = 0; i != nb_seg && len < pkt->pkt_len; i++) {
548                 len += seglen[i];
549                 md[i] = NULL;
550         }
551
552         n = pkt->pkt_len - len;
553
554         /* update size of the last segment to fit rest of the packet */
555         if (n >= 0) {
556                 seglen[i - 1] += n;
557                 len += n;
558         }
559
560         nb_seg = i;
561         while (i != 0) {
562                 p = rte_pktmbuf_alloc(mp);
563                 if (p == NULL) {
564                         RTE_LOG(ERR, USER1,
565                                 "failed to allocate %u-th of %u mbuf "
566                                 "from mempool: %s\n",
567                                 nb_seg - i, nb_seg, mp->name);
568                         break;
569                 }
570
571                 md[--i] = p;
572                 if (rte_pktmbuf_tailroom(md[i]) < seglen[i]) {
573                         RTE_LOG(ERR, USER1, "mempool %s, %u-th segment: "
574                                 "expected seglen: %u, "
575                                 "actual mbuf tailroom: %u\n",
576                                 mp->name, i, seglen[i],
577                                 rte_pktmbuf_tailroom(md[i]));
578                         break;
579                 }
580         }
581
582         /* all mbufs successfully allocated, do copy */
583         if (i == 0) {
584                 rc = mbuf_copy_split(pkt, md, seglen, nb_seg);
585                 if (rc < 0)
586                         RTE_LOG(ERR, USER1,
587                                 "mbuf_copy_split for %p(len=%u, nb_seg=%hhu) "
588                                 "into %u segments failed with error code: %d\n",
589                                 pkt, pkt->pkt_len, pkt->nb_segs, nb_seg, rc);
590
591                 /* figure out how many mbufs to free. */
592                 i = RTE_MAX(rc, 0);
593         }
594
595         /* free unused mbufs */
596         for (; i != nb_seg; i++) {
597                 rte_pktmbuf_free_seg(md[i]);
598                 md[i] = NULL;
599         }
600
601         return md[0];
602 }
603
604 /*
605  * Receive a burst of packets, and for each packet:
606  *  - parse packet, and try to recognize a supported packet type (1)
607  *  - if it's not a supported packet type, don't touch the packet, else:
608  *  - reprocess the checksum of all supported layers. This is done in SW
609  *    or HW, depending on testpmd command line configuration
610  *  - if TSO is enabled in testpmd command line, also flag the mbuf for TCP
611  *    segmentation offload (this implies HW TCP checksum)
612  * Then transmit packets on the output port.
613  *
614  * (1) Supported packets are:
615  *   Ether / (vlan) / IP|IP6 / UDP|TCP|SCTP .
616  *   Ether / (vlan) / outer IP|IP6 / outer UDP / VxLAN / Ether / IP|IP6 /
617  *           UDP|TCP|SCTP
618  *   Ether / (vlan) / outer IP|IP6 / GRE / Ether / IP|IP6 / UDP|TCP|SCTP
619  *   Ether / (vlan) / outer IP|IP6 / GRE / IP|IP6 / UDP|TCP|SCTP
620  *   Ether / (vlan) / outer IP|IP6 / IP|IP6 / UDP|TCP|SCTP
621  *
622  * The testpmd command line for this forward engine sets the flags
623  * TESTPMD_TX_OFFLOAD_* in ports[tx_port].tx_ol_flags. They control
624  * wether a checksum must be calculated in software or in hardware. The
625  * IP, UDP, TCP and SCTP flags always concern the inner layer. The
626  * OUTER_IP is only useful for tunnel packets.
627  */
628 static void
629 pkt_burst_checksum_forward(struct fwd_stream *fs)
630 {
631         struct rte_mbuf *pkts_burst[MAX_PKT_BURST];
632         struct rte_port *txp;
633         struct rte_mbuf *m, *p;
634         struct ether_hdr *eth_hdr;
635         void *l3_hdr = NULL, *outer_l3_hdr = NULL; /* can be IPv4 or IPv6 */
636         uint16_t nb_rx;
637         uint16_t nb_tx;
638         uint16_t i;
639         uint64_t rx_ol_flags, tx_ol_flags;
640         uint16_t testpmd_ol_flags;
641         uint32_t retry;
642         uint32_t rx_bad_ip_csum;
643         uint32_t rx_bad_l4_csum;
644         struct testpmd_offload_info info;
645
646 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
647         uint64_t start_tsc;
648         uint64_t end_tsc;
649         uint64_t core_cycles;
650 #endif
651
652 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
653         start_tsc = rte_rdtsc();
654 #endif
655
656         /* receive a burst of packet */
657         nb_rx = rte_eth_rx_burst(fs->rx_port, fs->rx_queue, pkts_burst,
658                                  nb_pkt_per_burst);
659         if (unlikely(nb_rx == 0))
660                 return;
661
662 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
663         fs->rx_burst_stats.pkt_burst_spread[nb_rx]++;
664 #endif
665         fs->rx_packets += nb_rx;
666         rx_bad_ip_csum = 0;
667         rx_bad_l4_csum = 0;
668
669         txp = &ports[fs->tx_port];
670         testpmd_ol_flags = txp->tx_ol_flags;
671         memset(&info, 0, sizeof(info));
672         info.tso_segsz = txp->tso_segsz;
673         info.tunnel_tso_segsz = txp->tunnel_tso_segsz;
674
675         for (i = 0; i < nb_rx; i++) {
676                 if (likely(i < nb_rx - 1))
677                         rte_prefetch0(rte_pktmbuf_mtod(pkts_burst[i + 1],
678                                                        void *));
679
680                 m = pkts_burst[i];
681                 info.is_tunnel = 0;
682                 tx_ol_flags = 0;
683                 rx_ol_flags = m->ol_flags;
684
685                 /* Update the L3/L4 checksum error packet statistics */
686                 rx_bad_ip_csum += ((rx_ol_flags & PKT_RX_IP_CKSUM_BAD) != 0);
687                 rx_bad_l4_csum += ((rx_ol_flags & PKT_RX_L4_CKSUM_BAD) != 0);
688
689                 /* step 1: dissect packet, parsing optional vlan, ip4/ip6, vxlan
690                  * and inner headers */
691
692                 eth_hdr = rte_pktmbuf_mtod(m, struct ether_hdr *);
693                 ether_addr_copy(&peer_eth_addrs[fs->peer_addr],
694                                 &eth_hdr->d_addr);
695                 ether_addr_copy(&ports[fs->tx_port].eth_addr,
696                                 &eth_hdr->s_addr);
697                 parse_ethernet(eth_hdr, &info);
698                 l3_hdr = (char *)eth_hdr + info.l2_len;
699
700                 /* check if it's a supported tunnel */
701                 if (testpmd_ol_flags & TESTPMD_TX_OFFLOAD_PARSE_TUNNEL) {
702                         if (info.l4_proto == IPPROTO_UDP) {
703                                 struct udp_hdr *udp_hdr;
704
705                                 udp_hdr = (struct udp_hdr *)((char *)l3_hdr +
706                                         info.l3_len);
707                                 parse_vxlan(udp_hdr, &info, m->packet_type);
708                                 if (info.is_tunnel)
709                                         tx_ol_flags |= PKT_TX_TUNNEL_VXLAN;
710                         } else if (info.l4_proto == IPPROTO_GRE) {
711                                 struct simple_gre_hdr *gre_hdr;
712
713                                 gre_hdr = (struct simple_gre_hdr *)
714                                         ((char *)l3_hdr + info.l3_len);
715                                 parse_gre(gre_hdr, &info);
716                                 if (info.is_tunnel)
717                                         tx_ol_flags |= PKT_TX_TUNNEL_GRE;
718                         } else if (info.l4_proto == IPPROTO_IPIP) {
719                                 void *encap_ip_hdr;
720
721                                 encap_ip_hdr = (char *)l3_hdr + info.l3_len;
722                                 parse_encap_ip(encap_ip_hdr, &info);
723                                 if (info.is_tunnel)
724                                         tx_ol_flags |= PKT_TX_TUNNEL_IPIP;
725                         }
726                 }
727
728                 /* update l3_hdr and outer_l3_hdr if a tunnel was parsed */
729                 if (info.is_tunnel) {
730                         outer_l3_hdr = l3_hdr;
731                         l3_hdr = (char *)l3_hdr + info.outer_l3_len + info.l2_len;
732                 }
733
734                 /* step 2: depending on user command line configuration,
735                  * recompute checksum either in software or flag the
736                  * mbuf to offload the calculation to the NIC. If TSO
737                  * is configured, prepare the mbuf for TCP segmentation. */
738
739                 /* process checksums of inner headers first */
740                 tx_ol_flags |= process_inner_cksums(l3_hdr, &info,
741                         testpmd_ol_flags);
742
743                 /* Then process outer headers if any. Note that the software
744                  * checksum will be wrong if one of the inner checksums is
745                  * processed in hardware. */
746                 if (info.is_tunnel == 1) {
747                         tx_ol_flags |= process_outer_cksums(outer_l3_hdr, &info,
748                                         testpmd_ol_flags,
749                                         !!(tx_ol_flags & PKT_TX_TCP_SEG));
750                 }
751
752                 /* step 3: fill the mbuf meta data (flags and header lengths) */
753
754                 if (info.is_tunnel == 1) {
755                         if (info.tunnel_tso_segsz ||
756                             testpmd_ol_flags & TESTPMD_TX_OFFLOAD_OUTER_IP_CKSUM) {
757                                 m->outer_l2_len = info.outer_l2_len;
758                                 m->outer_l3_len = info.outer_l3_len;
759                                 m->l2_len = info.l2_len;
760                                 m->l3_len = info.l3_len;
761                                 m->l4_len = info.l4_len;
762                                 m->tso_segsz = info.tunnel_tso_segsz;
763                         }
764                         else {
765                                 /* if there is a outer UDP cksum
766                                    processed in sw and the inner in hw,
767                                    the outer checksum will be wrong as
768                                    the payload will be modified by the
769                                    hardware */
770                                 m->l2_len = info.outer_l2_len +
771                                         info.outer_l3_len + info.l2_len;
772                                 m->l3_len = info.l3_len;
773                                 m->l4_len = info.l4_len;
774                         }
775                 } else {
776                         /* this is only useful if an offload flag is
777                          * set, but it does not hurt to fill it in any
778                          * case */
779                         m->l2_len = info.l2_len;
780                         m->l3_len = info.l3_len;
781                         m->l4_len = info.l4_len;
782                         m->tso_segsz = info.tso_segsz;
783                 }
784                 m->ol_flags = tx_ol_flags;
785
786                 /* Do split & copy for the packet. */
787                 if (tx_pkt_split != TX_PKT_SPLIT_OFF) {
788                         p = pkt_copy_split(m);
789                         if (p != NULL) {
790                                 rte_pktmbuf_free(m);
791                                 m = p;
792                                 pkts_burst[i] = m;
793                         }
794                 }
795
796                 /* if verbose mode is enabled, dump debug info */
797                 if (verbose_level > 0) {
798                         char buf[256];
799
800                         printf("-----------------\n");
801                         printf("mbuf=%p, pkt_len=%u, nb_segs=%hhu:\n",
802                                 m, m->pkt_len, m->nb_segs);
803                         /* dump rx parsed packet info */
804                         rte_get_rx_ol_flag_list(rx_ol_flags, buf, sizeof(buf));
805                         printf("rx: l2_len=%d ethertype=%x l3_len=%d "
806                                 "l4_proto=%d l4_len=%d flags=%s\n",
807                                 info.l2_len, rte_be_to_cpu_16(info.ethertype),
808                                 info.l3_len, info.l4_proto, info.l4_len, buf);
809                         if (info.is_tunnel == 1)
810                                 printf("rx: outer_l2_len=%d outer_ethertype=%x "
811                                         "outer_l3_len=%d\n", info.outer_l2_len,
812                                         rte_be_to_cpu_16(info.outer_ethertype),
813                                         info.outer_l3_len);
814                         /* dump tx packet info */
815                         if ((testpmd_ol_flags & (TESTPMD_TX_OFFLOAD_IP_CKSUM |
816                                                 TESTPMD_TX_OFFLOAD_UDP_CKSUM |
817                                                 TESTPMD_TX_OFFLOAD_TCP_CKSUM |
818                                                 TESTPMD_TX_OFFLOAD_SCTP_CKSUM)) ||
819                                 info.tso_segsz != 0)
820                                 printf("tx: m->l2_len=%d m->l3_len=%d "
821                                         "m->l4_len=%d\n",
822                                         m->l2_len, m->l3_len, m->l4_len);
823                         if (info.is_tunnel == 1) {
824                                 if (testpmd_ol_flags &
825                                     TESTPMD_TX_OFFLOAD_OUTER_IP_CKSUM)
826                                         printf("tx: m->outer_l2_len=%d "
827                                                 "m->outer_l3_len=%d\n",
828                                                 m->outer_l2_len,
829                                                 m->outer_l3_len);
830                                 if (info.tunnel_tso_segsz != 0)
831                                         printf("tx: m->tso_segsz=%d\n",
832                                                 m->tso_segsz);
833                         } else if (info.tso_segsz != 0)
834                                 printf("tx: m->tso_segsz=%d\n", m->tso_segsz);
835                         rte_get_tx_ol_flag_list(m->ol_flags, buf, sizeof(buf));
836                         printf("tx: flags=%s", buf);
837                         printf("\n");
838                 }
839         }
840         nb_tx = rte_eth_tx_burst(fs->tx_port, fs->tx_queue, pkts_burst, nb_rx);
841         /*
842          * Retry if necessary
843          */
844         if (unlikely(nb_tx < nb_rx) && fs->retry_enabled) {
845                 retry = 0;
846                 while (nb_tx < nb_rx && retry++ < burst_tx_retry_num) {
847                         rte_delay_us(burst_tx_delay_time);
848                         nb_tx += rte_eth_tx_burst(fs->tx_port, fs->tx_queue,
849                                         &pkts_burst[nb_tx], nb_rx - nb_tx);
850                 }
851         }
852         fs->tx_packets += nb_tx;
853         fs->rx_bad_ip_csum += rx_bad_ip_csum;
854         fs->rx_bad_l4_csum += rx_bad_l4_csum;
855
856 #ifdef RTE_TEST_PMD_RECORD_BURST_STATS
857         fs->tx_burst_stats.pkt_burst_spread[nb_tx]++;
858 #endif
859         if (unlikely(nb_tx < nb_rx)) {
860                 fs->fwd_dropped += (nb_rx - nb_tx);
861                 do {
862                         rte_pktmbuf_free(pkts_burst[nb_tx]);
863                 } while (++nb_tx < nb_rx);
864         }
865 #ifdef RTE_TEST_PMD_RECORD_CORE_CYCLES
866         end_tsc = rte_rdtsc();
867         core_cycles = (end_tsc - start_tsc);
868         fs->core_cycles = (uint64_t) (fs->core_cycles + core_cycles);
869 #endif
870 }
871
872 struct fwd_engine csum_fwd_engine = {
873         .fwd_mode_name  = "csum",
874         .port_fwd_begin = NULL,
875         .port_fwd_end   = NULL,
876         .packet_fwd     = pkt_burst_checksum_forward,
877 };