4 * Copyright(c) 2017 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
39 * Interface to GSO library
49 /* Minimum GSO segment size. */
50 #define RTE_GSO_SEG_SIZE_MIN (sizeof(struct ether_hdr) + \
51 sizeof(struct ipv4_hdr) + sizeof(struct tcp_hdr) + 1)
53 /* GSO flags for rte_gso_ctx. */
54 #define RTE_GSO_FLAG_IPID_FIXED (1ULL << 0)
55 /**< Use fixed IP ids for output GSO segments. Setting
56 * 0 indicates using incremental IP ids.
60 * GSO context structure.
63 struct rte_mempool *direct_pool;
64 /**< MBUF pool for allocating direct buffers, which are used
65 * to store packet headers for GSO segments.
67 struct rte_mempool *indirect_pool;
68 /**< MBUF pool for allocating indirect buffers, which are used
69 * to locate packet payloads for GSO segments. The indirect
70 * buffer doesn't contain any data, but simply points to an
71 * offset within the packet to segment.
74 /**< flag that controls specific attributes of output segments,
75 * such as the type of IP ID generated (i.e. fixed or incremental).
78 /**< the bit mask of required GSO types. The GSO library
79 * uses the same macros as that of describing device TX
80 * offloading capabilities (i.e. DEV_TX_OFFLOAD_*_TSO) for
83 * For example, if applications want to segment TCP/IPv4
84 * packets, set DEV_TX_OFFLOAD_TCP_TSO in gso_types.
87 /**< maximum size of an output GSO segment, including packet
88 * header and payload, measured in bytes. Must exceed
89 * RTE_GSO_SEG_SIZE_MIN.
94 * Segmentation function, which supports processing of both single- and
95 * multi- MBUF packets.
97 * Note that we refer to the packets that are segmented from the input
98 * packet as 'GSO segments'. rte_gso_segment() doesn't check if the
99 * input packet has correct checksums, and doesn't update checksums for
100 * output GSO segments. Additionally, it doesn't process IP fragment
103 * Before calling rte_gso_segment(), applications must set proper ol_flags
104 * for the packet. The GSO library uses the same macros as that of TSO.
105 * For example, set PKT_TX_TCP_SEG and PKT_TX_IPV4 in ol_flags to segment
106 * a TCP/IPv4 packet. If rte_gso_segment() succceds, the PKT_TX_TCP_SEG
107 * flag is removed for all GSO segments and the input packet.
109 * Each of the newly-created GSO segments is organized as a two-segment
110 * MBUF, where the first segment is a standard MBUF, which stores a copy
111 * of packet header, and the second is an indirect MBUF which points to
112 * a section of data in the input packet. Since each GSO segment has
113 * multiple MBUFs (i.e. typically 2 MBUFs), the driver of the interface which
114 * the GSO segments are sent to should support transmission of multi-segment
117 * If the input packet is GSO'd, its mbuf refcnt reduces by 1. Therefore,
118 * when all GSO segments are freed, the input packet is freed automatically.
120 * If the memory space in pkts_out or MBUF pools is insufficient, this
121 * function fails, and it returns (-1) * errno. Otherwise, GSO succeeds,
122 * and this function returns the number of output GSO segments filled in
126 * The packet mbuf to segment.
128 * GSO context object pointer.
130 * Pointer array used to store the MBUF addresses of output GSO
131 * segments, when rte_gso_segment() succeeds.
133 * The max number of items that pkts_out can keep.
136 * - The number of GSO segments filled in pkts_out on success.
137 * - Return -ENOMEM if run out of memory in MBUF pools.
138 * - Return -EINVAL for invalid parameters.
140 int rte_gso_segment(struct rte_mbuf *pkt,
141 const struct rte_gso_ctx *ctx,
142 struct rte_mbuf **pkts_out,
143 uint16_t nb_pkts_out);
148 #endif /* _RTE_GSO_H_ */