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