1 /* SPDX-License-Identifier: BSD-3-Clause
3 * Copyright (c) 2010-2015 Intel Corporation
4 * Copyright (c) 2007,2008 Kip Macy kmacy@freebsd.org
6 * Derived from FreeBSD's bufring.h
7 * Used as BSD-3 Licensed with permission from Kip Macy.
16 #include <sys/queue.h>
18 #include <rte_common.h>
20 #include <rte_memory.h>
21 #include <rte_memzone.h>
22 #include <rte_malloc.h>
23 #include <rte_launch.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>
36 #include "rte_ring_elem.h"
38 TAILQ_HEAD(rte_ring_list, rte_tailq_entry);
40 static struct rte_tailq_elem rte_ring_tailq = {
41 .name = RTE_TAILQ_RING_NAME,
43 EAL_REGISTER_TAILQ(rte_ring_tailq)
45 /* true if x is a power of 2 */
46 #define POWEROF2(x) ((((x)-1) & (x)) == 0)
48 /* return the size of memory occupied by a ring */
50 rte_ring_get_memsize_elem(unsigned int esize, unsigned int count)
54 /* Check if element size is a multiple of 4B */
56 RTE_LOG(ERR, RING, "element size is not a multiple of 4\n");
61 /* count must be a power of 2 */
62 if ((!POWEROF2(count)) || (count > RTE_RING_SZ_MASK )) {
64 "Requested number of elements is invalid, must be power of 2, and not exceed %u\n",
70 sz = sizeof(struct rte_ring) + count * esize;
71 sz = RTE_ALIGN(sz, RTE_CACHE_LINE_SIZE);
75 /* return the size of memory occupied by a ring */
77 rte_ring_get_memsize(unsigned int count)
79 return rte_ring_get_memsize_elem(sizeof(void *), count);
83 rte_ring_reset(struct rte_ring *r)
85 r->prod.head = r->cons.head = 0;
86 r->prod.tail = r->cons.tail = 0;
90 rte_ring_init(struct rte_ring *r, const char *name, unsigned count,
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);
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;
109 r->prod.single = (flags & RING_F_SP_ENQ) ? __IS_SP : __IS_MP;
110 r->cons.single = (flags & RING_F_SC_DEQ) ? __IS_SC : __IS_MC;
112 if (flags & RING_F_EXACT_SZ) {
113 r->size = rte_align32pow2(count + 1);
114 r->mask = r->size - 1;
117 if ((!POWEROF2(count)) || (count > RTE_RING_SZ_MASK)) {
119 "Requested size is invalid, must be power of 2, and not exceed the size limit %u\n",
125 r->capacity = r->mask;
127 r->prod.head = r->cons.head = 0;
128 r->prod.tail = r->cons.tail = 0;
133 /* create the ring for a given element size */
135 rte_ring_create_elem(const char *name, unsigned int esize, unsigned int count,
136 int socket_id, unsigned int flags)
138 char mz_name[RTE_MEMZONE_NAMESIZE];
140 struct rte_tailq_entry *te;
141 const struct rte_memzone *mz;
144 struct rte_ring_list* ring_list = NULL;
145 const unsigned int requested_count = count;
148 ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
150 /* for an exact size ring, round up from count to a power of two */
151 if (flags & RING_F_EXACT_SZ)
152 count = rte_align32pow2(count + 1);
154 ring_size = rte_ring_get_memsize_elem(esize, count);
156 rte_errno = ring_size;
160 ret = snprintf(mz_name, sizeof(mz_name), "%s%s",
161 RTE_RING_MZ_PREFIX, name);
162 if (ret < 0 || ret >= (int)sizeof(mz_name)) {
163 rte_errno = ENAMETOOLONG;
167 te = rte_zmalloc("RING_TAILQ_ENTRY", sizeof(*te), 0);
169 RTE_LOG(ERR, RING, "Cannot reserve memory for tailq\n");
174 rte_mcfg_tailq_write_lock();
176 /* reserve a memory zone for this ring. If we can't get rte_config or
177 * we are secondary process, the memzone_reserve function will set
178 * rte_errno for us appropriately - hence no check in this this function */
179 mz = rte_memzone_reserve_aligned(mz_name, ring_size, socket_id,
180 mz_flags, __alignof__(*r));
183 /* no need to check return value here, we already checked the
185 rte_ring_init(r, name, requested_count, flags);
187 te->data = (void *) r;
190 TAILQ_INSERT_TAIL(ring_list, te, next);
193 RTE_LOG(ERR, RING, "Cannot reserve memory\n");
196 rte_mcfg_tailq_write_unlock();
201 /* create the ring */
203 rte_ring_create(const char *name, unsigned int count, int socket_id,
206 return rte_ring_create_elem(name, sizeof(void *), count, socket_id,
212 rte_ring_free(struct rte_ring *r)
214 struct rte_ring_list *ring_list = NULL;
215 struct rte_tailq_entry *te;
221 * Ring was not created with rte_ring_create,
222 * therefore, there is no memzone to free.
224 if (r->memzone == NULL) {
226 "Cannot free ring, not created with rte_ring_create()\n");
230 if (rte_memzone_free(r->memzone) != 0) {
231 RTE_LOG(ERR, RING, "Cannot free memory\n");
235 ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
236 rte_mcfg_tailq_write_lock();
238 /* find out tailq entry */
239 TAILQ_FOREACH(te, ring_list, next) {
240 if (te->data == (void *) r)
245 rte_mcfg_tailq_write_unlock();
249 TAILQ_REMOVE(ring_list, te, next);
251 rte_mcfg_tailq_write_unlock();
256 /* dump the status of the ring on the console */
258 rte_ring_dump(FILE *f, const struct rte_ring *r)
260 fprintf(f, "ring <%s>@%p\n", r->name, r);
261 fprintf(f, " flags=%x\n", r->flags);
262 fprintf(f, " size=%"PRIu32"\n", r->size);
263 fprintf(f, " capacity=%"PRIu32"\n", r->capacity);
264 fprintf(f, " ct=%"PRIu32"\n", r->cons.tail);
265 fprintf(f, " ch=%"PRIu32"\n", r->cons.head);
266 fprintf(f, " pt=%"PRIu32"\n", r->prod.tail);
267 fprintf(f, " ph=%"PRIu32"\n", r->prod.head);
268 fprintf(f, " used=%u\n", rte_ring_count(r));
269 fprintf(f, " avail=%u\n", rte_ring_free_count(r));
272 /* dump the status of all rings on the console */
274 rte_ring_list_dump(FILE *f)
276 const struct rte_tailq_entry *te;
277 struct rte_ring_list *ring_list;
279 ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
281 rte_mcfg_tailq_read_lock();
283 TAILQ_FOREACH(te, ring_list, next) {
284 rte_ring_dump(f, (struct rte_ring *) te->data);
287 rte_mcfg_tailq_read_unlock();
290 /* search a ring from its name */
292 rte_ring_lookup(const char *name)
294 struct rte_tailq_entry *te;
295 struct rte_ring *r = NULL;
296 struct rte_ring_list *ring_list;
298 ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
300 rte_mcfg_tailq_read_lock();
302 TAILQ_FOREACH(te, ring_list, next) {
303 r = (struct rte_ring *) te->data;
304 if (strncmp(name, r->name, RTE_RING_NAMESIZE) == 0)
308 rte_mcfg_tailq_read_unlock();