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