lib/librte_ring/rte_ring.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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
  35 /*
  36  * Derived from FreeBSD's bufring.c
  37  *
  38  **************************************************************************
  39  *
  40  * Copyright (c) 2007,2008 Kip Macy kmacy@freebsd.org
  41  * All rights reserved.
  42  *
  43  * Redistribution and use in source and binary forms, with or without
  44  * modification, are permitted provided that the following conditions are met:
  45  *
  46  * 1. Redistributions of source code must retain the above copyright notice,
  47  *    this list of conditions and the following disclaimer.
  48  *
  49  * 2. The name of Kip Macy nor the names of other
  50  *    contributors may be used to endorse or promote products derived from
  51  *    this software without specific prior written permission.
  52  *
  53  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  54  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  55  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  56  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  57  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  58  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  59  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  60  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  61  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  62  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  63  * POSSIBILITY OF SUCH DAMAGE.
  64  *
  65  ***************************************************************************/
  66
  67 #include <stdio.h>
  68 #include <stdarg.h>
  69 #include <string.h>
  70 #include <stdint.h>
  71 #include <inttypes.h>
  72 #include <errno.h>
  73 #include <sys/queue.h>
  74
  75 #include <rte_common.h>
  76 #include <rte_log.h>
  77 #include <rte_memory.h>
  78 #include <rte_memzone.h>
  79 #include <rte_launch.h>
  80 #include <rte_tailq.h>
  81 #include <rte_eal.h>
  82 #include <rte_eal_memconfig.h>
  83 #include <rte_atomic.h>
  84 #include <rte_per_lcore.h>
  85 #include <rte_lcore.h>
  86 #include <rte_branch_prediction.h>
  87 #include <rte_errno.h>
  88 #include <rte_string_fns.h>
  89
  90 #include "rte_ring.h"
  91
  92 TAILQ_HEAD(rte_ring_list, rte_ring);
  93
  94 /* true if x is a power of 2 */
  95 #define POWEROF2(x) ((((x)-1) & (x)) == 0)
  96
  97 /* create the ring */
  98 struct rte_ring *
  99 rte_ring_create(const char *name, unsigned count, int socket_id,
 100                 unsigned flags)
 101 {
 102         char mz_name[RTE_MEMZONE_NAMESIZE];
 103         struct rte_ring *r;
 104         const struct rte_memzone *mz;
 105         size_t ring_size;
 106         int mz_flags = 0;
 107         struct rte_ring_list* ring_list = NULL;
 108
 109         /* compilation-time checks */
 110         RTE_BUILD_BUG_ON((sizeof(struct rte_ring) &
 111                           CACHE_LINE_MASK) != 0);
 112         RTE_BUILD_BUG_ON((offsetof(struct rte_ring, cons) &
 113                           CACHE_LINE_MASK) != 0);
 114         RTE_BUILD_BUG_ON((offsetof(struct rte_ring, prod) &
 115                           CACHE_LINE_MASK) != 0);
 116 #ifdef RTE_LIBRTE_RING_DEBUG
 117         RTE_BUILD_BUG_ON((sizeof(struct rte_ring_debug_stats) &
 118                           CACHE_LINE_MASK) != 0);
 119         RTE_BUILD_BUG_ON((offsetof(struct rte_ring, stats) &
 120                           CACHE_LINE_MASK) != 0);
 121 #endif
 122
 123         /* check that we have an initialised tail queue */
 124         if ((ring_list =
 125              RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_RING, rte_ring_list)) == NULL) {
 126                 rte_errno = E_RTE_NO_TAILQ;
 127                 return NULL;
 128         }
 129
 130         /* count must be a power of 2 */
 131         if ((!POWEROF2(count)) || (count > RTE_RING_SZ_MASK )) {
 132                 rte_errno = EINVAL;
 133                 RTE_LOG(ERR, RING, "Requested size is invalid, must be power of 2, and "
 134                                 "do not exceed the size limit %u\n", RTE_RING_SZ_MASK);
 135                 return NULL;
 136         }
 137
 138         rte_snprintf(mz_name, sizeof(mz_name), "RG_%s", name);
 139         ring_size = count * sizeof(void *) + sizeof(struct rte_ring);
 140
 141         /* reserve a memory zone for this ring. If we can't get rte_config or
 142          * we are secondary process, the memzone_reserve function will set
 143          * rte_errno for us appropriately - hence no check in this this function */
 144         mz = rte_memzone_reserve(mz_name, ring_size, socket_id, mz_flags);
 145         if (mz != NULL) {
 146                 r = mz->addr;
 147
 148                 /* init the ring structure */
 149                 memset(r, 0, sizeof(*r));
 150                 rte_snprintf(r->name, sizeof(r->name), "%s", name);
 151                 r->flags = flags;
 152                 r->prod.watermark = count;
 153                 r->prod.sp_enqueue = !!(flags & RING_F_SP_ENQ);
 154                 r->cons.sc_dequeue = !!(flags & RING_F_SC_DEQ);
 155                 r->prod.size = r->cons.size = count;
 156                 r->prod.mask = r->cons.mask = count-1;
 157                 r->prod.head = r->cons.head = 0;
 158                 r->prod.tail = r->cons.tail = 0;
 159
 160                 TAILQ_INSERT_TAIL(ring_list, r, next);
 161         } else {
 162                 r = NULL;
 163                 RTE_LOG(ERR, RING, "Cannot reserve memory\n");
 164         }
 165
 166         return r;
 167 }
 168
 169 /*
 170  * change the high water mark. If *count* is 0, water marking is
 171  * disabled
 172  */
 173 int
 174 rte_ring_set_water_mark(struct rte_ring *r, unsigned count)
 175 {
 176         if (count >= r->prod.size)
 177                 return -EINVAL;
 178
 179         /* if count is 0, disable the watermarking */
 180         if (count == 0)
 181                 count = r->prod.size;
 182
 183         r->prod.watermark = count;
 184         return 0;
 185 }
 186
 187 /* dump the status of the ring on the console */
 188 void
 189 rte_ring_dump(const struct rte_ring *r)
 190 {
 191 #ifdef RTE_LIBRTE_RING_DEBUG
 192         struct rte_ring_debug_stats sum;
 193         unsigned lcore_id;
 194 #endif
 195
 196         printf("ring <%s>@%p\n", r->name, r);
 197         printf("  flags=%x\n", r->flags);
 198         printf("  size=%"PRIu32"\n", r->prod.size);
 199         printf("  ct=%"PRIu32"\n", r->cons.tail);
 200         printf("  ch=%"PRIu32"\n", r->cons.head);
 201         printf("  pt=%"PRIu32"\n", r->prod.tail);
 202         printf("  ph=%"PRIu32"\n", r->prod.head);
 203         printf("  used=%u\n", rte_ring_count(r));
 204         printf("  avail=%u\n", rte_ring_free_count(r));
 205         if (r->prod.watermark == r->prod.size)
 206                 printf("  watermark=0\n");
 207         else
 208                 printf("  watermark=%"PRIu32"\n", r->prod.watermark);
 209
 210         /* sum and dump statistics */
 211 #ifdef RTE_LIBRTE_RING_DEBUG
 212         memset(&sum, 0, sizeof(sum));
 213         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
 214                 sum.enq_success_bulk += r->stats[lcore_id].enq_success_bulk;
 215                 sum.enq_success_objs += r->stats[lcore_id].enq_success_objs;
 216                 sum.enq_quota_bulk += r->stats[lcore_id].enq_quota_bulk;
 217                 sum.enq_quota_objs += r->stats[lcore_id].enq_quota_objs;
 218                 sum.enq_fail_bulk += r->stats[lcore_id].enq_fail_bulk;
 219                 sum.enq_fail_objs += r->stats[lcore_id].enq_fail_objs;
 220                 sum.deq_success_bulk += r->stats[lcore_id].deq_success_bulk;
 221                 sum.deq_success_objs += r->stats[lcore_id].deq_success_objs;
 222                 sum.deq_fail_bulk += r->stats[lcore_id].deq_fail_bulk;
 223                 sum.deq_fail_objs += r->stats[lcore_id].deq_fail_objs;
 224         }
 225         printf("  size=%"PRIu32"\n", r->prod.size);
 226         printf("  enq_success_bulk=%"PRIu64"\n", sum.enq_success_bulk);
 227         printf("  enq_success_objs=%"PRIu64"\n", sum.enq_success_objs);
 228         printf("  enq_quota_bulk=%"PRIu64"\n", sum.enq_quota_bulk);
 229         printf("  enq_quota_objs=%"PRIu64"\n", sum.enq_quota_objs);
 230         printf("  enq_fail_bulk=%"PRIu64"\n", sum.enq_fail_bulk);
 231         printf("  enq_fail_objs=%"PRIu64"\n", sum.enq_fail_objs);
 232         printf("  deq_success_bulk=%"PRIu64"\n", sum.deq_success_bulk);
 233         printf("  deq_success_objs=%"PRIu64"\n", sum.deq_success_objs);
 234         printf("  deq_fail_bulk=%"PRIu64"\n", sum.deq_fail_bulk);
 235         printf("  deq_fail_objs=%"PRIu64"\n", sum.deq_fail_objs);
 236 #else
 237         printf("  no statistics available\n");
 238 #endif
 239 }
 240
 241 /* dump the status of all rings on the console */
 242 void
 243 rte_ring_list_dump(void)
 244 {
 245         const struct rte_ring *mp;
 246         struct rte_ring_list *ring_list;
 247
 248         /* check that we have an initialised tail queue */
 249         if ((ring_list =
 250              RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_RING, rte_ring_list)) == NULL) {
 251                 rte_errno = E_RTE_NO_TAILQ;
 252                 return;
 253         }
 254
 255         TAILQ_FOREACH(mp, ring_list, next) {
 256                 rte_ring_dump(mp);
 257         }
 258 }
 259
 260 /* search a ring from its name */
 261 struct rte_ring *
 262 rte_ring_lookup(const char *name)
 263 {
 264         struct rte_ring *r;
 265         struct rte_ring_list *ring_list;
 266
 267         /* check that we have an initialized tail queue */
 268         if ((ring_list =
 269              RTE_TAILQ_LOOKUP_BY_IDX(RTE_TAILQ_RING, rte_ring_list)) == NULL) {
 270                 rte_errno = E_RTE_NO_TAILQ;
 271                 return NULL;
 272         }
 273
 274         TAILQ_FOREACH(r, ring_list, next) {
 275                 if (strncmp(name, r->name, RTE_RING_NAMESIZE) == 0)
 276                         break;
 277         }
 278
 279         if (r == NULL)
 280                 rte_errno = ENOENT;
 281
 282         return r;
 283 }