version: 17.11-rc3
[dpdk.git] / lib / librte_gso / gso_tunnel_tcp4.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2017 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 #ifndef _GSO_TUNNEL_TCP4_H_
35 #define _GSO_TUNNEL_TCP4_H_
36
37 #include <stdint.h>
38 #include <rte_mbuf.h>
39
40 /**
41  * Segment a tunneling packet with inner TCP/IPv4 headers. This function
42  * doesn't check if the input packet has correct checksums, and doesn't
43  * update checksums for output GSO segments. Furthermore, it doesn't
44  * process IP fragment packets.
45  *
46  * @param pkt
47  *  The packet mbuf to segment.
48  * @param gso_size
49  *  The max length of a GSO segment, measured in bytes.
50  * @param ipid_delta
51  *  The increasing unit of IP ids.
52  * @param direct_pool
53  *  MBUF pool used for allocating direct buffers for output segments.
54  * @param indirect_pool
55  *  MBUF pool used for allocating indirect buffers for output segments.
56  * @param pkts_out
57  *  Pointer array used to store the MBUF addresses of output GSO
58  *  segments, when it succeeds. If the memory space in pkts_out is
59  *  insufficient, it fails and returns -EINVAL.
60  * @param nb_pkts_out
61  *  The max number of items that 'pkts_out' can keep.
62  *
63  * @return
64  *   - The number of GSO segments filled in pkts_out on success.
65  *   - Return -ENOMEM if run out of memory in MBUF pools.
66  *   - Return -EINVAL for invalid parameters.
67  */
68 int gso_tunnel_tcp4_segment(struct rte_mbuf *pkt,
69                 uint16_t gso_size,
70                 uint8_t ipid_delta,
71                 struct rte_mempool *direct_pool,
72                 struct rte_mempool *indirect_pool,
73                 struct rte_mbuf **pkts_out,
74                 uint16_t nb_pkts_out);
75 #endif