net: add rte prefix to IP defines
[dpdk.git] / lib / librte_ip_frag / rte_ipv4_fragmentation.c
index 6e5feb6..221d74e 100644 (file)
@@ -1,67 +1,33 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
- *   All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2010-2014 Intel Corporation
  */
 
 #include <stddef.h>
-#include <stdint.h>
 #include <errno.h>
 
-#include <rte_byteorder.h>
 #include <rte_memcpy.h>
 #include <rte_mempool.h>
 #include <rte_debug.h>
-#include <rte_mbuf.h>
-#include <rte_ip.h>
 
-#include "rte_ip_frag.h"
 #include "ip_frag_common.h"
 
 /* Fragment Offset */
-#define        IPV4_HDR_DF_SHIFT                       14
-#define        IPV4_HDR_MF_SHIFT                       13
-#define        IPV4_HDR_FO_SHIFT                       3
+#define        RTE_IPV4_HDR_DF_SHIFT                   14
+#define        RTE_IPV4_HDR_MF_SHIFT                   13
+#define        RTE_IPV4_HDR_FO_SHIFT                   3
 
-#define        IPV4_HDR_DF_MASK                        (1 << IPV4_HDR_DF_SHIFT)
-#define        IPV4_HDR_MF_MASK                        (1 << IPV4_HDR_MF_SHIFT)
+#define        IPV4_HDR_DF_MASK                        (1 << RTE_IPV4_HDR_DF_SHIFT)
+#define        IPV4_HDR_MF_MASK                        (1 << RTE_IPV4_HDR_MF_SHIFT)
 
-#define        IPV4_HDR_FO_MASK                        ((1 << IPV4_HDR_FO_SHIFT) - 1)
+#define        IPV4_HDR_FO_ALIGN                       (1 << RTE_IPV4_HDR_FO_SHIFT)
 
-static inline void __fill_ipv4hdr_frag(struct ipv4_hdr *dst,
-               const struct ipv4_hdr *src, uint16_t len, uint16_t fofs,
+static inline void __fill_ipv4hdr_frag(struct rte_ipv4_hdr *dst,
+               const struct rte_ipv4_hdr *src, uint16_t len, uint16_t fofs,
                uint16_t dofs, uint32_t mf)
 {
        rte_memcpy(dst, src, sizeof(*dst));
-       fofs = (uint16_t)(fofs + (dofs >> IPV4_HDR_FO_SHIFT));
-       fofs = (uint16_t)(fofs | mf << IPV4_HDR_MF_SHIFT);
+       fofs = (uint16_t)(fofs + (dofs >> RTE_IPV4_HDR_FO_SHIFT));
+       fofs = (uint16_t)(fofs | mf << RTE_IPV4_HDR_MF_SHIFT);
        dst->fragment_offset = rte_cpu_to_be_16(fofs);
        dst->total_length = rte_cpu_to_be_16(len);
        dst->hdr_checksum = 0;
@@ -96,7 +62,7 @@ static inline void __free_fragments(struct rte_mbuf *mb[], uint32_t num)
  *   Otherwise - (-1) * <errno>.
  */
 int32_t
-rte_ipv4_fragmentation(struct rte_mbuf *pkt_in,
+rte_ipv4_fragment_packet(struct rte_mbuf *pkt_in,
        struct rte_mbuf **pkts_out,
        uint16_t nb_pkts_out,
        uint16_t mtu_size,
@@ -104,17 +70,20 @@ rte_ipv4_fragmentation(struct rte_mbuf *pkt_in,
        struct rte_mempool *pool_indirect)
 {
        struct rte_mbuf *in_seg = NULL;
-       struct ipv4_hdr *in_hdr;
+       struct rte_ipv4_hdr *in_hdr;
        uint32_t out_pkt_pos, in_seg_data_pos;
        uint32_t more_in_segs;
        uint16_t fragment_offset, flag_offset, frag_size;
+       uint16_t frag_bytes_remaining;
 
-       frag_size = (uint16_t)(mtu_size - sizeof(struct ipv4_hdr));
-
-       /* Fragment size should be a multiply of 8. */
-       RTE_IP_FRAG_ASSERT((frag_size & IPV4_HDR_FO_MASK) == 0);
+       /*
+        * Ensure the IP payload length of all fragments is aligned to a
+        * multiple of 8 bytes as per RFC791 section 2.3.
+        */
+       frag_size = RTE_ALIGN_FLOOR((mtu_size - sizeof(struct rte_ipv4_hdr)),
+                                   IPV4_HDR_FO_ALIGN);
 
-       in_hdr = (struct ipv4_hdr *) pkt_in->pkt.data;
+       in_hdr = rte_pktmbuf_mtod(pkt_in, struct rte_ipv4_hdr *);
        flag_offset = rte_cpu_to_be_16(in_hdr->fragment_offset);
 
        /* If Don't Fragment flag is set */
@@ -123,11 +92,11 @@ rte_ipv4_fragmentation(struct rte_mbuf *pkt_in,
 
        /* Check that pkts_out is big enough to hold all fragments */
        if (unlikely(frag_size * nb_pkts_out <
-           (uint16_t)(pkt_in->pkt.pkt_len - sizeof (struct ipv4_hdr))))
+           (uint16_t)(pkt_in->pkt_len - sizeof(struct rte_ipv4_hdr))))
                return -EINVAL;
 
        in_seg = pkt_in;
-       in_seg_data_pos = sizeof(struct ipv4_hdr);
+       in_seg_data_pos = sizeof(struct rte_ipv4_hdr);
        out_pkt_pos = 0;
        fragment_offset = 0;
 
@@ -135,7 +104,7 @@ rte_ipv4_fragmentation(struct rte_mbuf *pkt_in,
        while (likely(more_in_segs)) {
                struct rte_mbuf *out_pkt = NULL, *out_seg_prev = NULL;
                uint32_t more_out_segs;
-               struct ipv4_hdr *out_hdr;
+               struct rte_ipv4_hdr *out_hdr;
 
                /* Allocate direct buffer */
                out_pkt = rte_pktmbuf_alloc(pool_direct);
@@ -145,8 +114,9 @@ rte_ipv4_fragmentation(struct rte_mbuf *pkt_in,
                }
 
                /* Reserve space for the IP header that will be built later */
-               out_pkt->pkt.data_len = sizeof(struct ipv4_hdr);
-               out_pkt->pkt.pkt_len = sizeof(struct ipv4_hdr);
+               out_pkt->data_len = sizeof(struct rte_ipv4_hdr);
+               out_pkt->pkt_len = sizeof(struct rte_ipv4_hdr);
+               frag_bytes_remaining = frag_size;
 
                out_seg_prev = out_pkt;
                more_out_segs = 1;
@@ -161,29 +131,30 @@ rte_ipv4_fragmentation(struct rte_mbuf *pkt_in,
                                __free_fragments(pkts_out, out_pkt_pos);
                                return -ENOMEM;
                        }
-                       out_seg_prev->pkt.next = out_seg;
+                       out_seg_prev->next = out_seg;
                        out_seg_prev = out_seg;
 
                        /* Prepare indirect buffer */
                        rte_pktmbuf_attach(out_seg, in_seg);
-                       len = mtu_size - out_pkt->pkt.pkt_len;
-                       if (len > (in_seg->pkt.data_len - in_seg_data_pos)) {
-                               len = in_seg->pkt.data_len - in_seg_data_pos;
+                       len = frag_bytes_remaining;
+                       if (len > (in_seg->data_len - in_seg_data_pos)) {
+                               len = in_seg->data_len - in_seg_data_pos;
                        }
-                       out_seg->pkt.data = (char*) in_seg->pkt.data + (uint16_t)in_seg_data_pos;
-                       out_seg->pkt.data_len = (uint16_t)len;
-                       out_pkt->pkt.pkt_len = (uint16_t)(len +
-                           out_pkt->pkt.pkt_len);
-                       out_pkt->pkt.nb_segs += 1;
+                       out_seg->data_off = in_seg->data_off + in_seg_data_pos;
+                       out_seg->data_len = (uint16_t)len;
+                       out_pkt->pkt_len = (uint16_t)(len +
+                           out_pkt->pkt_len);
+                       out_pkt->nb_segs += 1;
                        in_seg_data_pos += len;
+                       frag_bytes_remaining -= len;
 
                        /* Current output packet (i.e. fragment) done ? */
-                       if (unlikely(out_pkt->pkt.pkt_len >= mtu_size))
+                       if (unlikely(frag_bytes_remaining == 0))
                                more_out_segs = 0;
 
                        /* Current input segment done ? */
-                       if (unlikely(in_seg_data_pos == in_seg->pkt.data_len)) {
-                               in_seg = in_seg->pkt.next;
+                       if (unlikely(in_seg_data_pos == in_seg->data_len)) {
+                               in_seg = in_seg->next;
                                in_seg_data_pos = 0;
 
                                if (unlikely(in_seg == NULL))
@@ -193,17 +164,17 @@ rte_ipv4_fragmentation(struct rte_mbuf *pkt_in,
 
                /* Build the IP header */
 
-               out_hdr = (struct ipv4_hdr*) out_pkt->pkt.data;
+               out_hdr = rte_pktmbuf_mtod(out_pkt, struct rte_ipv4_hdr *);
 
                __fill_ipv4hdr_frag(out_hdr, in_hdr,
-                   (uint16_t)out_pkt->pkt.pkt_len,
+                   (uint16_t)out_pkt->pkt_len,
                    flag_offset, fragment_offset, more_in_segs);
 
                fragment_offset = (uint16_t)(fragment_offset +
-                   out_pkt->pkt.pkt_len - sizeof(struct ipv4_hdr));
+                   out_pkt->pkt_len - sizeof(struct rte_ipv4_hdr));
 
                out_pkt->ol_flags |= PKT_TX_IP_CKSUM;
-               out_pkt->pkt.vlan_macip.f.l3_len = sizeof(struct ipv4_hdr);
+               out_pkt->l3_len = sizeof(struct rte_ipv4_hdr);
 
                /* Write the fragment to the output list */
                pkts_out[out_pkt_pos] = out_pkt;