lib/librte_ring/rte_ring.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2015 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_malloc.h>
  79 #include <rte_launch.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_tailq_entry);
  93
  94 static struct rte_tailq_elem rte_ring_tailq = {
  95         .name = RTE_TAILQ_RING_NAME,
  96 };
  97 EAL_REGISTER_TAILQ(rte_ring_tailq)
  98
  99 /* true if x is a power of 2 */
 100 #define POWEROF2(x) ((((x)-1) & (x)) == 0)
 101
 102 /* return the size of memory occupied by a ring */
 103 ssize_t
 104 rte_ring_get_memsize(unsigned count)
 105 {
 106         ssize_t sz;
 107
 108         /* count must be a power of 2 */
 109         if ((!POWEROF2(count)) || (count > RTE_RING_SZ_MASK )) {
 110                 RTE_LOG(ERR, RING,
 111                         "Requested size is invalid, must be power of 2, and "
 112                         "do not exceed the size limit %u\n", RTE_RING_SZ_MASK);
 113                 return -EINVAL;
 114         }
 115
 116         sz = sizeof(struct rte_ring) + count * sizeof(void *);
 117         sz = RTE_ALIGN(sz, RTE_CACHE_LINE_SIZE);
 118         return sz;
 119 }
 120
 121 int
 122 rte_ring_init(struct rte_ring *r, const char *name, unsigned count,
 123         unsigned flags)
 124 {
 125         int ret;
 126
 127         /* compilation-time checks */
 128         RTE_BUILD_BUG_ON((sizeof(struct rte_ring) &
 129                           RTE_CACHE_LINE_MASK) != 0);
 130         RTE_BUILD_BUG_ON((offsetof(struct rte_ring, cons) &
 131                           RTE_CACHE_LINE_MASK) != 0);
 132         RTE_BUILD_BUG_ON((offsetof(struct rte_ring, prod) &
 133                           RTE_CACHE_LINE_MASK) != 0);
 134
 135         /* init the ring structure */
 136         memset(r, 0, sizeof(*r));
 137         ret = snprintf(r->name, sizeof(r->name), "%s", name);
 138         if (ret < 0 || ret >= (int)sizeof(r->name))
 139                 return -ENAMETOOLONG;
 140         r->flags = flags;
 141         r->watermark = count;
 142         r->prod.single = !!(flags & RING_F_SP_ENQ);
 143         r->cons.single = !!(flags & RING_F_SC_DEQ);
 144         r->size = count;
 145         r->mask = count - 1;
 146         r->prod.head = r->cons.head = 0;
 147         r->prod.tail = r->cons.tail = 0;
 148
 149         return 0;
 150 }
 151
 152 /* create the ring */
 153 struct rte_ring *
 154 rte_ring_create(const char *name, unsigned count, int socket_id,
 155                 unsigned flags)
 156 {
 157         char mz_name[RTE_MEMZONE_NAMESIZE];
 158         struct rte_ring *r;
 159         struct rte_tailq_entry *te;
 160         const struct rte_memzone *mz;
 161         ssize_t ring_size;
 162         int mz_flags = 0;
 163         struct rte_ring_list* ring_list = NULL;
 164         int ret;
 165
 166         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
 167
 168         ring_size = rte_ring_get_memsize(count);
 169         if (ring_size < 0) {
 170                 rte_errno = ring_size;
 171                 return NULL;
 172         }
 173
 174         ret = snprintf(mz_name, sizeof(mz_name), "%s%s",
 175                 RTE_RING_MZ_PREFIX, name);
 176         if (ret < 0 || ret >= (int)sizeof(mz_name)) {
 177                 rte_errno = ENAMETOOLONG;
 178                 return NULL;
 179         }
 180
 181         te = rte_zmalloc("RING_TAILQ_ENTRY", sizeof(*te), 0);
 182         if (te == NULL) {
 183                 RTE_LOG(ERR, RING, "Cannot reserve memory for tailq\n");
 184                 rte_errno = ENOMEM;
 185                 return NULL;
 186         }
 187
 188         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
 189
 190         /* reserve a memory zone for this ring. If we can't get rte_config or
 191          * we are secondary process, the memzone_reserve function will set
 192          * rte_errno for us appropriately - hence no check in this this function */
 193         mz = rte_memzone_reserve(mz_name, ring_size, socket_id, mz_flags);
 194         if (mz != NULL) {
 195                 r = mz->addr;
 196                 /* no need to check return value here, we already checked the
 197                  * arguments above */
 198                 rte_ring_init(r, name, count, flags);
 199
 200                 te->data = (void *) r;
 201                 r->memzone = mz;
 202
 203                 TAILQ_INSERT_TAIL(ring_list, te, next);
 204         } else {
 205                 r = NULL;
 206                 RTE_LOG(ERR, RING, "Cannot reserve memory\n");
 207                 rte_free(te);
 208         }
 209         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 210
 211         return r;
 212 }
 213
 214 /* free the ring */
 215 void
 216 rte_ring_free(struct rte_ring *r)
 217 {
 218         struct rte_ring_list *ring_list = NULL;
 219         struct rte_tailq_entry *te;
 220
 221         if (r == NULL)
 222                 return;
 223
 224         /*
 225          * Ring was not created with rte_ring_create,
 226          * therefore, there is no memzone to free.
 227          */
 228         if (r->memzone == NULL) {
 229                 RTE_LOG(ERR, RING, "Cannot free ring (not created with rte_ring_create()");
 230                 return;
 231         }
 232
 233         if (rte_memzone_free(r->memzone) != 0) {
 234                 RTE_LOG(ERR, RING, "Cannot free memory\n");
 235                 return;
 236         }
 237
 238         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
 239         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
 240
 241         /* find out tailq entry */
 242         TAILQ_FOREACH(te, ring_list, next) {
 243                 if (te->data == (void *) r)
 244                         break;
 245         }
 246
 247         if (te == NULL) {
 248                 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 249                 return;
 250         }
 251
 252         TAILQ_REMOVE(ring_list, te, next);
 253
 254         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 255
 256         rte_free(te);
 257 }
 258
 259 /*
 260  * change the high water mark. If *count* is 0, water marking is
 261  * disabled
 262  */
 263 int
 264 rte_ring_set_water_mark(struct rte_ring *r, unsigned count)
 265 {
 266         if (count >= r->size)
 267                 return -EINVAL;
 268
 269         /* if count is 0, disable the watermarking */
 270         if (count == 0)
 271                 count = r->size;
 272
 273         r->watermark = count;
 274         return 0;
 275 }
 276
 277 /* dump the status of the ring on the console */
 278 void
 279 rte_ring_dump(FILE *f, const struct rte_ring *r)
 280 {
 281         fprintf(f, "ring <%s>@%p\n", r->name, r);
 282         fprintf(f, "  flags=%x\n", r->flags);
 283         fprintf(f, "  size=%"PRIu32"\n", r->size);
 284         fprintf(f, "  ct=%"PRIu32"\n", r->cons.tail);
 285         fprintf(f, "  ch=%"PRIu32"\n", r->cons.head);
 286         fprintf(f, "  pt=%"PRIu32"\n", r->prod.tail);
 287         fprintf(f, "  ph=%"PRIu32"\n", r->prod.head);
 288         fprintf(f, "  used=%u\n", rte_ring_count(r));
 289         fprintf(f, "  avail=%u\n", rte_ring_free_count(r));
 290         if (r->watermark == r->size)
 291                 fprintf(f, "  watermark=0\n");
 292         else
 293                 fprintf(f, "  watermark=%"PRIu32"\n", r->watermark);
 294 }
 295
 296 /* dump the status of all rings on the console */
 297 void
 298 rte_ring_list_dump(FILE *f)
 299 {
 300         const struct rte_tailq_entry *te;
 301         struct rte_ring_list *ring_list;
 302
 303         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
 304
 305         rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
 306
 307         TAILQ_FOREACH(te, ring_list, next) {
 308                 rte_ring_dump(f, (struct rte_ring *) te->data);
 309         }
 310
 311         rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
 312 }
 313
 314 /* search a ring from its name */
 315 struct rte_ring *
 316 rte_ring_lookup(const char *name)
 317 {
 318         struct rte_tailq_entry *te;
 319         struct rte_ring *r = NULL;
 320         struct rte_ring_list *ring_list;
 321
 322         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
 323
 324         rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
 325
 326         TAILQ_FOREACH(te, ring_list, next) {
 327                 r = (struct rte_ring *) te->data;
 328                 if (strncmp(name, r->name, RTE_RING_NAMESIZE) == 0)
 329                         break;
 330         }
 331
 332         rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
 333
 334         if (te == NULL) {
 335                 rte_errno = ENOENT;
 336                 return NULL;
 337         }
 338
 339         return r;
 340 }