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         /* compilation-time checks */
 126         RTE_BUILD_BUG_ON((sizeof(struct rte_ring) &
 127                           RTE_CACHE_LINE_MASK) != 0);
 128 #ifdef RTE_RING_SPLIT_PROD_CONS
 129         RTE_BUILD_BUG_ON((offsetof(struct rte_ring, cons) &
 130                           RTE_CACHE_LINE_MASK) != 0);
 131 #endif
 132         RTE_BUILD_BUG_ON((offsetof(struct rte_ring, prod) &
 133                           RTE_CACHE_LINE_MASK) != 0);
 134 #ifdef RTE_LIBRTE_RING_DEBUG
 135         RTE_BUILD_BUG_ON((sizeof(struct rte_ring_debug_stats) &
 136                           RTE_CACHE_LINE_MASK) != 0);
 137         RTE_BUILD_BUG_ON((offsetof(struct rte_ring, stats) &
 138                           RTE_CACHE_LINE_MASK) != 0);
 139 #endif
 140
 141         /* init the ring structure */
 142         memset(r, 0, sizeof(*r));
 143         snprintf(r->name, sizeof(r->name), "%s", name);
 144         r->flags = flags;
 145         r->prod.watermark = count;
 146         r->prod.sp_enqueue = !!(flags & RING_F_SP_ENQ);
 147         r->cons.sc_dequeue = !!(flags & RING_F_SC_DEQ);
 148         r->prod.size = r->cons.size = count;
 149         r->prod.mask = r->cons.mask = count-1;
 150         r->prod.head = r->cons.head = 0;
 151         r->prod.tail = r->cons.tail = 0;
 152
 153         return 0;
 154 }
 155
 156 /* create the ring */
 157 struct rte_ring *
 158 rte_ring_create(const char *name, unsigned count, int socket_id,
 159                 unsigned flags)
 160 {
 161         char mz_name[RTE_MEMZONE_NAMESIZE];
 162         struct rte_ring *r;
 163         struct rte_tailq_entry *te;
 164         const struct rte_memzone *mz;
 165         ssize_t ring_size;
 166         int mz_flags = 0;
 167         struct rte_ring_list* ring_list = NULL;
 168
 169         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
 170
 171         ring_size = rte_ring_get_memsize(count);
 172         if (ring_size < 0) {
 173                 rte_errno = ring_size;
 174                 return NULL;
 175         }
 176
 177         te = rte_zmalloc("RING_TAILQ_ENTRY", sizeof(*te), 0);
 178         if (te == NULL) {
 179                 RTE_LOG(ERR, RING, "Cannot reserve memory for tailq\n");
 180                 rte_errno = ENOMEM;
 181                 return NULL;
 182         }
 183
 184         snprintf(mz_name, sizeof(mz_name), "%s%s", RTE_RING_MZ_PREFIX, name);
 185
 186         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
 187
 188         /* reserve a memory zone for this ring. If we can't get rte_config or
 189          * we are secondary process, the memzone_reserve function will set
 190          * rte_errno for us appropriately - hence no check in this this function */
 191         mz = rte_memzone_reserve(mz_name, ring_size, socket_id, mz_flags);
 192         if (mz != NULL) {
 193                 r = mz->addr;
 194                 /* no need to check return value here, we already checked the
 195                  * arguments above */
 196                 rte_ring_init(r, name, count, flags);
 197
 198                 te->data = (void *) r;
 199                 r->memzone = mz;
 200
 201                 TAILQ_INSERT_TAIL(ring_list, te, next);
 202         } else {
 203                 r = NULL;
 204                 RTE_LOG(ERR, RING, "Cannot reserve memory\n");
 205                 rte_free(te);
 206         }
 207         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 208
 209         return r;
 210 }
 211
 212 /* free the ring */
 213 void
 214 rte_ring_free(struct rte_ring *r)
 215 {
 216         struct rte_ring_list *ring_list = NULL;
 217         struct rte_tailq_entry *te;
 218
 219         if (r == NULL)
 220                 return;
 221
 222         /*
 223          * Ring was not created with rte_ring_create,
 224          * therefore, there is no memzone to free.
 225          */
 226         if (r->memzone == NULL) {
 227                 RTE_LOG(ERR, RING, "Cannot free ring (not created with rte_ring_create()");
 228                 return;
 229         }
 230
 231         if (rte_memzone_free(r->memzone) != 0) {
 232                 RTE_LOG(ERR, RING, "Cannot free memory\n");
 233                 return;
 234         }
 235
 236         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
 237         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
 238
 239         /* find out tailq entry */
 240         TAILQ_FOREACH(te, ring_list, next) {
 241                 if (te->data == (void *) r)
 242                         break;
 243         }
 244
 245         if (te == NULL) {
 246                 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 247                 return;
 248         }
 249
 250         TAILQ_REMOVE(ring_list, te, next);
 251
 252         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
 253
 254         rte_free(te);
 255 }
 256
 257 /*
 258  * change the high water mark. If *count* is 0, water marking is
 259  * disabled
 260  */
 261 int
 262 rte_ring_set_water_mark(struct rte_ring *r, unsigned count)
 263 {
 264         if (count >= r->prod.size)
 265                 return -EINVAL;
 266
 267         /* if count is 0, disable the watermarking */
 268         if (count == 0)
 269                 count = r->prod.size;
 270
 271         r->prod.watermark = count;
 272         return 0;
 273 }
 274
 275 /* dump the status of the ring on the console */
 276 void
 277 rte_ring_dump(FILE *f, const struct rte_ring *r)
 278 {
 279 #ifdef RTE_LIBRTE_RING_DEBUG
 280         struct rte_ring_debug_stats sum;
 281         unsigned lcore_id;
 282 #endif
 283
 284         fprintf(f, "ring <%s>@%p\n", r->name, r);
 285         fprintf(f, "  flags=%x\n", r->flags);
 286         fprintf(f, "  size=%"PRIu32"\n", r->prod.size);
 287         fprintf(f, "  ct=%"PRIu32"\n", r->cons.tail);
 288         fprintf(f, "  ch=%"PRIu32"\n", r->cons.head);
 289         fprintf(f, "  pt=%"PRIu32"\n", r->prod.tail);
 290         fprintf(f, "  ph=%"PRIu32"\n", r->prod.head);
 291         fprintf(f, "  used=%u\n", rte_ring_count(r));
 292         fprintf(f, "  avail=%u\n", rte_ring_free_count(r));
 293         if (r->prod.watermark == r->prod.size)
 294                 fprintf(f, "  watermark=0\n");
 295         else
 296                 fprintf(f, "  watermark=%"PRIu32"\n", r->prod.watermark);
 297
 298         /* sum and dump statistics */
 299 #ifdef RTE_LIBRTE_RING_DEBUG
 300         memset(&sum, 0, sizeof(sum));
 301         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
 302                 sum.enq_success_bulk += r->stats[lcore_id].enq_success_bulk;
 303                 sum.enq_success_objs += r->stats[lcore_id].enq_success_objs;
 304                 sum.enq_quota_bulk += r->stats[lcore_id].enq_quota_bulk;
 305                 sum.enq_quota_objs += r->stats[lcore_id].enq_quota_objs;
 306                 sum.enq_fail_bulk += r->stats[lcore_id].enq_fail_bulk;
 307                 sum.enq_fail_objs += r->stats[lcore_id].enq_fail_objs;
 308                 sum.deq_success_bulk += r->stats[lcore_id].deq_success_bulk;
 309                 sum.deq_success_objs += r->stats[lcore_id].deq_success_objs;
 310                 sum.deq_fail_bulk += r->stats[lcore_id].deq_fail_bulk;
 311                 sum.deq_fail_objs += r->stats[lcore_id].deq_fail_objs;
 312         }
 313         fprintf(f, "  size=%"PRIu32"\n", r->prod.size);
 314         fprintf(f, "  enq_success_bulk=%"PRIu64"\n", sum.enq_success_bulk);
 315         fprintf(f, "  enq_success_objs=%"PRIu64"\n", sum.enq_success_objs);
 316         fprintf(f, "  enq_quota_bulk=%"PRIu64"\n", sum.enq_quota_bulk);
 317         fprintf(f, "  enq_quota_objs=%"PRIu64"\n", sum.enq_quota_objs);
 318         fprintf(f, "  enq_fail_bulk=%"PRIu64"\n", sum.enq_fail_bulk);
 319         fprintf(f, "  enq_fail_objs=%"PRIu64"\n", sum.enq_fail_objs);
 320         fprintf(f, "  deq_success_bulk=%"PRIu64"\n", sum.deq_success_bulk);
 321         fprintf(f, "  deq_success_objs=%"PRIu64"\n", sum.deq_success_objs);
 322         fprintf(f, "  deq_fail_bulk=%"PRIu64"\n", sum.deq_fail_bulk);
 323         fprintf(f, "  deq_fail_objs=%"PRIu64"\n", sum.deq_fail_objs);
 324 #else
 325         fprintf(f, "  no statistics available\n");
 326 #endif
 327 }
 328
 329 /* dump the status of all rings on the console */
 330 void
 331 rte_ring_list_dump(FILE *f)
 332 {
 333         const struct rte_tailq_entry *te;
 334         struct rte_ring_list *ring_list;
 335
 336         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
 337
 338         rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
 339
 340         TAILQ_FOREACH(te, ring_list, next) {
 341                 rte_ring_dump(f, (struct rte_ring *) te->data);
 342         }
 343
 344         rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
 345 }
 346
 347 /* search a ring from its name */
 348 struct rte_ring *
 349 rte_ring_lookup(const char *name)
 350 {
 351         struct rte_tailq_entry *te;
 352         struct rte_ring *r = NULL;
 353         struct rte_ring_list *ring_list;
 354
 355         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
 356
 357         rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
 358
 359         TAILQ_FOREACH(te, ring_list, next) {
 360                 r = (struct rte_ring *) te->data;
 361                 if (strncmp(name, r->name, RTE_RING_NAMESIZE) == 0)
 362                         break;
 363         }
 364
 365         rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
 366
 367         if (te == NULL) {
 368                 rte_errno = ENOENT;
 369                 return NULL;
 370         }
 371
 372         return r;
 373 }