lib/librte_ring/rte_ring.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  *
   3  * Copyright (c) 2010-2015 Intel Corporation
   4  * Copyright (c) 2007,2008 Kip Macy kmacy@freebsd.org
   5  * All rights reserved.
   6  * Derived from FreeBSD's bufring.h
   7  * Used as BSD-3 Licensed with permission from Kip Macy.
   8  */
   9
  10 #include <stdio.h>
  11 #include <stdarg.h>
  12 #include <string.h>
  13 #include <stdint.h>
  14 #include <inttypes.h>
  15 #include <errno.h>
  16 #include <sys/queue.h>
  17
  18 #include <rte_common.h>
  19 #include <rte_log.h>
  20 #include <rte_memory.h>
  21 #include <rte_memzone.h>
  22 #include <rte_malloc.h>
  23 #include <rte_launch.h>
  24 #include <rte_eal.h>
  25 #include <rte_eal_memconfig.h>
  26 #include <rte_atomic.h>
  27 #include <rte_per_lcore.h>
  28 #include <rte_lcore.h>
  29 #include <rte_branch_prediction.h>
  30 #include <rte_errno.h>
  31 #include <rte_string_fns.h>
  32 #include <rte_spinlock.h>
  33 #include <rte_tailq.h>
  34
  35 #include "rte_ring.h"
  36 #include "rte_ring_elem.h"
  37
  38 TAILQ_HEAD(rte_ring_list, rte_tailq_entry);
  39
  40 static struct rte_tailq_elem rte_ring_tailq = {
  41         .name = RTE_TAILQ_RING_NAME,
  42 };
  43 EAL_REGISTER_TAILQ(rte_ring_tailq)
  44
  45 /* true if x is a power of 2 */
  46 #define POWEROF2(x) ((((x)-1) & (x)) == 0)
  47
  48 /* return the size of memory occupied by a ring */
  49 ssize_t
  50 rte_ring_get_memsize_elem(unsigned int esize, unsigned int count)
  51 {
  52         ssize_t sz;
  53
  54         /* Check if element size is a multiple of 4B */
  55         if (esize % 4 != 0) {
  56                 RTE_LOG(ERR, RING, "element size is not a multiple of 4\n");
  57
  58                 return -EINVAL;
  59         }
  60
  61         /* count must be a power of 2 */
  62         if ((!POWEROF2(count)) || (count > RTE_RING_SZ_MASK )) {
  63                 RTE_LOG(ERR, RING,
  64                         "Requested number of elements is invalid, must be power of 2, and not exceed %u\n",
  65                         RTE_RING_SZ_MASK);
  66
  67                 return -EINVAL;
  68         }
  69
  70         sz = sizeof(struct rte_ring) + count * esize;
  71         sz = RTE_ALIGN(sz, RTE_CACHE_LINE_SIZE);
  72         return sz;
  73 }
  74
  75 /* return the size of memory occupied by a ring */
  76 ssize_t
  77 rte_ring_get_memsize(unsigned int count)
  78 {
  79         return rte_ring_get_memsize_elem(sizeof(void *), count);
  80 }
  81
  82 void
  83 rte_ring_reset(struct rte_ring *r)
  84 {
  85         r->prod.head = r->cons.head = 0;
  86         r->prod.tail = r->cons.tail = 0;
  87 }
  88
  89 int
  90 rte_ring_init(struct rte_ring *r, const char *name, unsigned count,
  91         unsigned flags)
  92 {
  93         int ret;
  94
  95         /* compilation-time checks */
  96         RTE_BUILD_BUG_ON((sizeof(struct rte_ring) &
  97                           RTE_CACHE_LINE_MASK) != 0);
  98         RTE_BUILD_BUG_ON((offsetof(struct rte_ring, cons) &
  99                           RTE_CACHE_LINE_MASK) != 0);
 100         RTE_BUILD_BUG_ON((offsetof(struct rte_ring, prod) &
 101                           RTE_CACHE_LINE_MASK) != 0);
 102
 103         /* init the ring structure */
 104         memset(r, 0, sizeof(*r));
 105         ret = strlcpy(r->name, name, sizeof(r->name));
 106         if (ret < 0 || ret >= (int)sizeof(r->name))
 107                 return -ENAMETOOLONG;
 108         r->flags = flags;
 109         r->prod.sync_type = (flags & RING_F_SP_ENQ) ?
 110                 RTE_RING_SYNC_ST : RTE_RING_SYNC_MT;
 111         r->cons.sync_type = (flags & RING_F_SC_DEQ) ?
 112                 RTE_RING_SYNC_ST : RTE_RING_SYNC_MT;
 113
 114         if (flags & RING_F_EXACT_SZ) {
 115                 r->size = rte_align32pow2(count + 1);
 116                 r->mask = r->size - 1;
 117                 r->capacity = count;
 118         } else {
 119                 if ((!POWEROF2(count)) || (count > RTE_RING_SZ_MASK)) {
 120                         RTE_LOG(ERR, RING,
 121                                 "Requested size is invalid, must be power of 2, and not exceed the size limit %u\n",
 122                                 RTE_RING_SZ_MASK);
 123                         return -EINVAL;
 124                 }
 125                 r->size = count;
 126                 r->mask = count - 1;
 127                 r->capacity = r->mask;
 128         }
 129         r->prod.head = r->cons.head = 0;
 130         r->prod.tail = r->cons.tail = 0;
 131
 132         return 0;
 133 }
 134
 135 /* create the ring for a given element size */
 136 struct rte_ring *
 137 rte_ring_create_elem(const char *name, unsigned int esize, unsigned int count,
 138                 int socket_id, unsigned int flags)
 139 {
 140         char mz_name[RTE_MEMZONE_NAMESIZE];
 141         struct rte_ring *r;
 142         struct rte_tailq_entry *te;
 143         const struct rte_memzone *mz;
 144         ssize_t ring_size;
 145         int mz_flags = 0;
 146         struct rte_ring_list* ring_list = NULL;
 147         const unsigned int requested_count = count;
 148         int ret;
 149
 150         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
 151
 152         /* for an exact size ring, round up from count to a power of two */
 153         if (flags & RING_F_EXACT_SZ)
 154                 count = rte_align32pow2(count + 1);
 155
 156         ring_size = rte_ring_get_memsize_elem(esize, count);
 157         if (ring_size < 0) {
 158                 rte_errno = ring_size;
 159                 return NULL;
 160         }
 161
 162         ret = snprintf(mz_name, sizeof(mz_name), "%s%s",
 163                 RTE_RING_MZ_PREFIX, name);
 164         if (ret < 0 || ret >= (int)sizeof(mz_name)) {
 165                 rte_errno = ENAMETOOLONG;
 166                 return NULL;
 167         }
 168
 169         te = rte_zmalloc("RING_TAILQ_ENTRY", sizeof(*te), 0);
 170         if (te == NULL) {
 171                 RTE_LOG(ERR, RING, "Cannot reserve memory for tailq\n");
 172                 rte_errno = ENOMEM;
 173                 return NULL;
 174         }
 175
 176         rte_mcfg_tailq_write_lock();
 177
 178         /* reserve a memory zone for this ring. If we can't get rte_config or
 179          * we are secondary process, the memzone_reserve function will set
 180          * rte_errno for us appropriately - hence no check in this this function */
 181         mz = rte_memzone_reserve_aligned(mz_name, ring_size, socket_id,
 182                                          mz_flags, __alignof__(*r));
 183         if (mz != NULL) {
 184                 r = mz->addr;
 185                 /* no need to check return value here, we already checked the
 186                  * arguments above */
 187                 rte_ring_init(r, name, requested_count, flags);
 188
 189                 te->data = (void *) r;
 190                 r->memzone = mz;
 191
 192                 TAILQ_INSERT_TAIL(ring_list, te, next);
 193         } else {
 194                 r = NULL;
 195                 RTE_LOG(ERR, RING, "Cannot reserve memory\n");
 196                 rte_free(te);
 197         }
 198         rte_mcfg_tailq_write_unlock();
 199
 200         return r;
 201 }
 202
 203 /* create the ring */
 204 struct rte_ring *
 205 rte_ring_create(const char *name, unsigned int count, int socket_id,
 206                 unsigned int flags)
 207 {
 208         return rte_ring_create_elem(name, sizeof(void *), count, socket_id,
 209                 flags);
 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,
 228                         "Cannot free ring, not created with rte_ring_create()\n");
 229                 return;
 230         }
 231
 232         if (rte_memzone_free(r->memzone) != 0) {
 233                 RTE_LOG(ERR, RING, "Cannot free memory\n");
 234                 return;
 235         }
 236
 237         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
 238         rte_mcfg_tailq_write_lock();
 239
 240         /* find out tailq entry */
 241         TAILQ_FOREACH(te, ring_list, next) {
 242                 if (te->data == (void *) r)
 243                         break;
 244         }
 245
 246         if (te == NULL) {
 247                 rte_mcfg_tailq_write_unlock();
 248                 return;
 249         }
 250
 251         TAILQ_REMOVE(ring_list, te, next);
 252
 253         rte_mcfg_tailq_write_unlock();
 254
 255         rte_free(te);
 256 }
 257
 258 /* dump the status of the ring on the console */
 259 void
 260 rte_ring_dump(FILE *f, const struct rte_ring *r)
 261 {
 262         fprintf(f, "ring <%s>@%p\n", r->name, r);
 263         fprintf(f, "  flags=%x\n", r->flags);
 264         fprintf(f, "  size=%"PRIu32"\n", r->size);
 265         fprintf(f, "  capacity=%"PRIu32"\n", r->capacity);
 266         fprintf(f, "  ct=%"PRIu32"\n", r->cons.tail);
 267         fprintf(f, "  ch=%"PRIu32"\n", r->cons.head);
 268         fprintf(f, "  pt=%"PRIu32"\n", r->prod.tail);
 269         fprintf(f, "  ph=%"PRIu32"\n", r->prod.head);
 270         fprintf(f, "  used=%u\n", rte_ring_count(r));
 271         fprintf(f, "  avail=%u\n", rte_ring_free_count(r));
 272 }
 273
 274 /* dump the status of all rings on the console */
 275 void
 276 rte_ring_list_dump(FILE *f)
 277 {
 278         const struct rte_tailq_entry *te;
 279         struct rte_ring_list *ring_list;
 280
 281         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
 282
 283         rte_mcfg_tailq_read_lock();
 284
 285         TAILQ_FOREACH(te, ring_list, next) {
 286                 rte_ring_dump(f, (struct rte_ring *) te->data);
 287         }
 288
 289         rte_mcfg_tailq_read_unlock();
 290 }
 291
 292 /* search a ring from its name */
 293 struct rte_ring *
 294 rte_ring_lookup(const char *name)
 295 {
 296         struct rte_tailq_entry *te;
 297         struct rte_ring *r = NULL;
 298         struct rte_ring_list *ring_list;
 299
 300         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
 301
 302         rte_mcfg_tailq_read_lock();
 303
 304         TAILQ_FOREACH(te, ring_list, next) {
 305                 r = (struct rte_ring *) te->data;
 306                 if (strncmp(name, r->name, RTE_RING_NAMESIZE) == 0)
 307                         break;
 308         }
 309
 310         rte_mcfg_tailq_read_unlock();
 311
 312         if (te == NULL) {
 313                 rte_errno = ENOENT;
 314                 return NULL;
 315         }
 316
 317         return r;
 318 }