lib/gso/gso_udp4.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2018 Intel Corporation
   3  */
   4
   5 #ifndef _GSO_UDP4_H_
   6 #define _GSO_UDP4_H_
   7
   8 #include <stdint.h>
   9
  10 /**
  11  * Segment an UDP/IPv4 packet. This function doesn't check if the input
  12  * packet has correct checksums, and doesn't update checksums for output
  13  * GSO segments. Furthermore, it doesn't process IP fragment packets.
  14  *
  15  * @param pkt
  16  *  The packet mbuf to segment.
  17  * @param gso_size
  18  *  The max length of a GSO segment, measured in bytes.
  19  * @param direct_pool
  20  *  MBUF pool used for allocating direct buffers for output segments.
  21  * @param indirect_pool
  22  *  MBUF pool used for allocating indirect buffers for output segments.
  23  * @param pkts_out
  24  *  Pointer array used to store the MBUF addresses of output GSO
  25  *  segments, when the function succeeds. If the memory space in
  26  *  pkts_out is insufficient, it fails and returns -EINVAL.
  27  * @param nb_pkts_out
  28  *  The max number of items that 'pkts_out' can keep.
  29  *
  30  * @return
  31  *   - The number of GSO segments filled in pkts_out on success.
  32  *   - Return -ENOMEM if run out of memory in MBUF pools.
  33  *   - Return -EINVAL for invalid parameters.
  34  */
  35 int gso_udp4_segment(struct rte_mbuf *pkt,
  36                 uint16_t gso_size,
  37                 struct rte_mempool *direct_pool,
  38                 struct rte_mempool *indirect_pool,
  39                 struct rte_mbuf **pkts_out,
  40                 uint16_t nb_pkts_out);
  41 #endif