lib/librte_port/rte_port_ring.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_RING_H__
  35 #define __INCLUDE_RTE_PORT_RING_H__
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /**
  42  * @file
  43  * RTE Port Ring
  44  *
  45  * ring_reader:
  46  *      input port built on top of pre-initialized single consumer ring
  47  * ring_writer:
  48  *      output port built on top of pre-initialized single producer ring
  49  * ring_multi_reader:
  50  *      input port built on top of pre-initialized multi consumers ring
  51  * ring_multi_writer:
  52  *      output port built on top of pre-initialized multi producers ring
  53  *
  54  ***/
  55
  56 #include <stdint.h>
  57
  58 #include <rte_ring.h>
  59
  60 #include "rte_port.h"
  61
  62 /** ring_reader port parameters */
  63 struct rte_port_ring_reader_params {
  64         /** Underlying consumer ring that has to be pre-initialized */
  65         struct rte_ring *ring;
  66 };
  67
  68 /** ring_reader port operations */
  69 extern struct rte_port_in_ops rte_port_ring_reader_ops;
  70
  71 /** ring_writer port parameters */
  72 struct rte_port_ring_writer_params {
  73         /** Underlying producer ring that has to be pre-initialized */
  74         struct rte_ring *ring;
  75
  76         /** Recommended burst size to ring. The actual burst size can be
  77                 bigger or smaller than this value. */
  78         uint32_t tx_burst_sz;
  79 };
  80
  81 /** ring_writer port operations */
  82 extern struct rte_port_out_ops rte_port_ring_writer_ops;
  83
  84 /** ring_writer_nodrop port parameters */
  85 struct rte_port_ring_writer_nodrop_params {
  86         /** Underlying producer ring that has to be pre-initialized */
  87         struct rte_ring *ring;
  88
  89         /** Recommended burst size to ring. The actual burst size can be
  90                 bigger or smaller than this value. */
  91         uint32_t tx_burst_sz;
  92
  93         /** Maximum number of retries, 0 for no limit */
  94         uint32_t n_retries;
  95 };
  96
  97 /** ring_writer_nodrop port operations */
  98 extern struct rte_port_out_ops rte_port_ring_writer_nodrop_ops;
  99
 100 /** ring_multi_reader port parameters */
 101 #define rte_port_ring_multi_reader_params rte_port_ring_reader_params
 102
 103 /** ring_multi_reader port operations */
 104 extern struct rte_port_in_ops rte_port_ring_multi_reader_ops;
 105
 106 /** ring_multi_writer port parameters */
 107 #define rte_port_ring_multi_writer_params rte_port_ring_writer_params
 108
 109 /** ring_multi_writer port operations */
 110 extern struct rte_port_out_ops rte_port_ring_multi_writer_ops;
 111
 112 /** ring_multi_writer_nodrop port parameters */
 113 #define rte_port_ring_multi_writer_nodrop_params \
 114         rte_port_ring_writer_nodrop_params
 115
 116 /** ring_multi_writer_nodrop port operations */
 117 extern struct rte_port_out_ops rte_port_ring_multi_writer_nodrop_ops;
 118
 119 #ifdef __cplusplus
 120 }
 121 #endif
 122
 123 #endif