lib/librte_port/rte_port_ring.c

   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 #include <string.h>
  34
  35 #include <rte_mbuf.h>
  36 #include <rte_ring.h>
  37 #include <rte_malloc.h>
  38
  39 #include "rte_port_ring.h"
  40
  41 /*
  42  * Port RING Reader
  43  */
  44 struct rte_port_ring_reader {
  45         struct rte_ring *ring;
  46 };
  47
  48 static void *
  49 rte_port_ring_reader_create(void *params, int socket_id)
  50 {
  51         struct rte_port_ring_reader_params *conf =
  52                         (struct rte_port_ring_reader_params *) params;
  53         struct rte_port_ring_reader *port;
  54
  55         /* Check input parameters */
  56         if (conf == NULL) {
  57                 RTE_LOG(ERR, PORT, "%s: params is NULL\n", __func__);
  58                 return NULL;
  59         }
  60
  61         /* Memory allocation */
  62         port = rte_zmalloc_socket("PORT", sizeof(*port),
  63                         RTE_CACHE_LINE_SIZE, socket_id);
  64         if (port == NULL) {
  65                 RTE_LOG(ERR, PORT, "%s: Failed to allocate port\n", __func__);
  66                 return NULL;
  67         }
  68
  69         /* Initialization */
  70         port->ring = conf->ring;
  71
  72         return port;
  73 }
  74
  75 static int
  76 rte_port_ring_reader_rx(void *port, struct rte_mbuf **pkts, uint32_t n_pkts)
  77 {
  78         struct rte_port_ring_reader *p = (struct rte_port_ring_reader *) port;
  79
  80         return rte_ring_sc_dequeue_burst(p->ring, (void **) pkts, n_pkts);
  81 }
  82
  83 static int
  84 rte_port_ring_reader_free(void *port)
  85 {
  86         if (port == NULL) {
  87                 RTE_LOG(ERR, PORT, "%s: port is NULL\n", __func__);
  88                 return -EINVAL;
  89         }
  90
  91         rte_free(port);
  92
  93         return 0;
  94 }
  95
  96 /*
  97  * Port RING Writer
  98  */
  99 struct rte_port_ring_writer {
 100         struct rte_mbuf *tx_buf[RTE_PORT_IN_BURST_SIZE_MAX];
 101         struct rte_ring *ring;
 102         uint32_t tx_burst_sz;
 103         uint32_t tx_buf_count;
 104 };
 105
 106 static void *
 107 rte_port_ring_writer_create(void *params, int socket_id)
 108 {
 109         struct rte_port_ring_writer_params *conf =
 110                         (struct rte_port_ring_writer_params *) params;
 111         struct rte_port_ring_writer *port;
 112
 113         /* Check input parameters */
 114         if ((conf == NULL) ||
 115             (conf->ring == NULL) ||
 116                 (conf->tx_burst_sz > RTE_PORT_IN_BURST_SIZE_MAX)) {
 117                 RTE_LOG(ERR, PORT, "%s: Invalid Parameters\n", __func__);
 118                 return NULL;
 119         }
 120
 121         /* Memory allocation */
 122         port = rte_zmalloc_socket("PORT", sizeof(*port),
 123                         RTE_CACHE_LINE_SIZE, socket_id);
 124         if (port == NULL) {
 125                 RTE_LOG(ERR, PORT, "%s: Failed to allocate port\n", __func__);
 126                 return NULL;
 127         }
 128
 129         /* Initialization */
 130         port->ring = conf->ring;
 131         port->tx_burst_sz = conf->tx_burst_sz;
 132         port->tx_buf_count = 0;
 133
 134         return port;
 135 }
 136
 137 static inline void
 138 send_burst(struct rte_port_ring_writer *p)
 139 {
 140         uint32_t nb_tx;
 141
 142         nb_tx = rte_ring_sp_enqueue_burst(p->ring, (void **)p->tx_buf,
 143                         p->tx_buf_count);
 144
 145         for ( ; nb_tx < p->tx_buf_count; nb_tx++)
 146                 rte_pktmbuf_free(p->tx_buf[nb_tx]);
 147
 148         p->tx_buf_count = 0;
 149 }
 150
 151 static int
 152 rte_port_ring_writer_tx(void *port, struct rte_mbuf *pkt)
 153 {
 154         struct rte_port_ring_writer *p = (struct rte_port_ring_writer *) port;
 155
 156         p->tx_buf[p->tx_buf_count++] = pkt;
 157         if (p->tx_buf_count >= p->tx_burst_sz)
 158                 send_burst(p);
 159
 160         return 0;
 161 }
 162
 163 static int
 164 rte_port_ring_writer_tx_bulk(void *port,
 165                 struct rte_mbuf **pkts,
 166                 uint64_t pkts_mask)
 167 {
 168         struct rte_port_ring_writer *p = (struct rte_port_ring_writer *) port;
 169
 170         if ((pkts_mask & (pkts_mask + 1)) == 0) {
 171                 uint64_t n_pkts = __builtin_popcountll(pkts_mask);
 172                 uint32_t i;
 173
 174                 for (i = 0; i < n_pkts; i++) {
 175                         struct rte_mbuf *pkt = pkts[i];
 176
 177                         p->tx_buf[p->tx_buf_count++] = pkt;
 178                         if (p->tx_buf_count >= p->tx_burst_sz)
 179                                 send_burst(p);
 180                 }
 181         } else {
 182                 for ( ; pkts_mask; ) {
 183                         uint32_t pkt_index = __builtin_ctzll(pkts_mask);
 184                         uint64_t pkt_mask = 1LLU << pkt_index;
 185                         struct rte_mbuf *pkt = pkts[pkt_index];
 186
 187                         p->tx_buf[p->tx_buf_count++] = pkt;
 188                         if (p->tx_buf_count >= p->tx_burst_sz)
 189                                 send_burst(p);
 190                         pkts_mask &= ~pkt_mask;
 191                 }
 192         }
 193
 194         return 0;
 195 }
 196
 197 static int
 198 rte_port_ring_writer_flush(void *port)
 199 {
 200         struct rte_port_ring_writer *p = (struct rte_port_ring_writer *) port;
 201
 202         if (p->tx_buf_count > 0)
 203                 send_burst(p);
 204
 205         return 0;
 206 }
 207
 208 static int
 209 rte_port_ring_writer_free(void *port)
 210 {
 211         if (port == NULL) {
 212                 RTE_LOG(ERR, PORT, "%s: Port is NULL\n", __func__);
 213                 return -EINVAL;
 214         }
 215
 216         rte_port_ring_writer_flush(port);
 217         rte_free(port);
 218
 219         return 0;
 220 }
 221
 222 /*
 223  * Summary of port operations
 224  */
 225 struct rte_port_in_ops rte_port_ring_reader_ops = {
 226         .f_create = rte_port_ring_reader_create,
 227         .f_free = rte_port_ring_reader_free,
 228         .f_rx = rte_port_ring_reader_rx,
 229 };
 230
 231 struct rte_port_out_ops rte_port_ring_writer_ops = {
 232         .f_create = rte_port_ring_writer_create,
 233         .f_free = rte_port_ring_writer_free,
 234         .f_tx = rte_port_ring_writer_tx,
 235         .f_tx_bulk = rte_port_ring_writer_tx_bulk,
 236         .f_flush = rte_port_ring_writer_flush,
 237 };