lib/librte_ip_frag/rte_ip_frag.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 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 _RTE_IP_FRAG_H__
  35 #define _RTE_IP_FRAG_H__
  36
  37 /**
  38  * @file
  39  * RTE IPv4 Fragmentation
  40  *
  41  * Implementation of IPv4 fragmentation.
  42  *
  43  */
  44
  45 /**
  46  * IPv4 fragmentation.
  47  *
  48  * This function implements the fragmentation of IPv4 packets.
  49  *
  50  * @param pkt_in
  51  *   The input packet.
  52  * @param pkts_out
  53  *   Array storing the output fragments.
  54  * @param nb_pkts_out
  55  *   Number of fragments.
  56  * @param mtu_size
  57  *   Size in bytes of the Maximum Transfer Unit (MTU) for the outgoing IPv4
  58  *   datagrams. This value includes the size of the IPv4 header.
  59  * @param pool_direct
  60  *   MBUF pool used for allocating direct buffers for the output fragments.
  61  * @param pool_indirect
  62  *   MBUF pool used for allocating indirect buffers for the output fragments.
  63  * @return
  64  *   Upon successful completion - number of output fragments placed
  65  *   in the pkts_out array.
  66  *   Otherwise - (-1) * errno.
  67  */
  68 int32_t rte_ipv4_fragmentation(struct rte_mbuf *pkt_in,
  69         struct rte_mbuf **pkts_out,
  70         uint16_t nb_pkts_out,
  71         uint16_t mtu_size,
  72         struct rte_mempool *pool_direct,
  73         struct rte_mempool *pool_indirect);
  74
  75 #endif