lib/librte_port/rte_port_ras.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 __INCLUDE_RTE_PORT_RAS_H__
  35 #define __INCLUDE_RTE_PORT_RAS_H__
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /**
  42  * @file
  43  * RTE Port for IPv4 Reassembly
  44  *
  45  * This port is built on top of pre-initialized single producer rte_ring. In
  46  * order to minimize the amount of packets stored in the ring at any given
  47  * time, the IP reassembly functionality is executed on ring write operation,
  48  * hence this port is implemented as an output port. A regular ring_reader port
  49  * can be created to read from the same ring.
  50  *
  51  * The packets written to the ring are either complete IP datagrams or IP
  52  * fragments. The packets read from the ring are all complete IP datagrams,
  53  * either jumbo frames (i.e. IP packets with length bigger than MTU) or not.
  54  * The complete IP datagrams written to the ring are not changed. The IP
  55  * fragments written to the ring are first reassembled and into complete IP
  56  * datagrams or dropped on error or IP reassembly time-out.
  57  *
  58  ***/
  59
  60 #include <stdint.h>
  61
  62 #include <rte_ring.h>
  63
  64 #include "rte_port.h"
  65
  66 /** ring_writer_ipv4_ras port parameters */
  67 struct rte_port_ring_writer_ras_params {
  68         /** Underlying single consumer ring that has to be pre-initialized. */
  69         struct rte_ring *ring;
  70
  71         /** Recommended burst size to ring. The actual burst size can be bigger
  72         or smaller than this value. */
  73         uint32_t tx_burst_sz;
  74 };
  75
  76 #define rte_port_ring_writer_ipv4_ras_params rte_port_ring_writer_ras_params
  77
  78 #define rte_port_ring_writer_ipv6_ras_params rte_port_ring_writer_ras_params
  79
  80 /** ring_writer_ipv4_ras port operations */
  81 extern struct rte_port_out_ops rte_port_ring_writer_ipv4_ras_ops;
  82
  83 /** ring_writer_ipv6_ras port operations */
  84 extern struct rte_port_out_ops rte_port_ring_writer_ipv6_ras_ops;
  85
  86 #ifdef __cplusplus
  87 }
  88 #endif
  89
  90 #endif