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>
37 TAILQ_HEAD(rte_ring_list, rte_tailq_entry);
39 static struct rte_tailq_elem rte_ring_tailq = {
40 .name = RTE_TAILQ_RING_NAME,
42 EAL_REGISTER_TAILQ(rte_ring_tailq)
44 /* true if x is a power of 2 */
45 #define POWEROF2(x) ((((x)-1) & (x)) == 0)
47 /* return the size of memory occupied by a ring */
49 rte_ring_get_memsize(unsigned count)
53 /* count must be a power of 2 */
54 if ((!POWEROF2(count)) || (count > RTE_RING_SZ_MASK )) {
56 "Requested size is invalid, must be power of 2, and "
57 "do not exceed the size limit %u\n", RTE_RING_SZ_MASK);
61 sz = sizeof(struct rte_ring) + count * sizeof(void *);
62 sz = RTE_ALIGN(sz, RTE_CACHE_LINE_SIZE);
67 rte_ring_reset(struct rte_ring *r)
69 r->prod.head = r->cons.head = 0;
70 r->prod.tail = r->cons.tail = 0;
74 rte_ring_init(struct rte_ring *r, const char *name, unsigned count,
79 /* compilation-time checks */
80 RTE_BUILD_BUG_ON((sizeof(struct rte_ring) &
81 RTE_CACHE_LINE_MASK) != 0);
82 RTE_BUILD_BUG_ON((offsetof(struct rte_ring, cons) &
83 RTE_CACHE_LINE_MASK) != 0);
84 RTE_BUILD_BUG_ON((offsetof(struct rte_ring, prod) &
85 RTE_CACHE_LINE_MASK) != 0);
87 /* init the ring structure */
88 memset(r, 0, sizeof(*r));
89 ret = strlcpy(r->name, name, sizeof(r->name));
90 if (ret < 0 || ret >= (int)sizeof(r->name))
93 r->prod.single = (flags & RING_F_SP_ENQ) ? __IS_SP : __IS_MP;
94 r->cons.single = (flags & RING_F_SC_DEQ) ? __IS_SC : __IS_MC;
96 if (flags & RING_F_EXACT_SZ) {
97 r->size = rte_align32pow2(count + 1);
98 r->mask = r->size - 1;
101 if ((!POWEROF2(count)) || (count > RTE_RING_SZ_MASK)) {
103 "Requested size is invalid, must be power of 2, and not exceed the size limit %u\n",
109 r->capacity = r->mask;
111 r->prod.head = r->cons.head = 0;
112 r->prod.tail = r->cons.tail = 0;
117 /* create the ring */
119 rte_ring_create(const char *name, unsigned count, int socket_id,
122 char mz_name[RTE_MEMZONE_NAMESIZE];
124 struct rte_tailq_entry *te;
125 const struct rte_memzone *mz;
128 struct rte_ring_list* ring_list = NULL;
129 const unsigned int requested_count = count;
132 ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
134 /* for an exact size ring, round up from count to a power of two */
135 if (flags & RING_F_EXACT_SZ)
136 count = rte_align32pow2(count + 1);
138 ring_size = rte_ring_get_memsize(count);
140 rte_errno = ring_size;
144 ret = snprintf(mz_name, sizeof(mz_name), "%s%s",
145 RTE_RING_MZ_PREFIX, name);
146 if (ret < 0 || ret >= (int)sizeof(mz_name)) {
147 rte_errno = ENAMETOOLONG;
151 te = rte_zmalloc("RING_TAILQ_ENTRY", sizeof(*te), 0);
153 RTE_LOG(ERR, RING, "Cannot reserve memory for tailq\n");
158 rte_mcfg_tailq_write_lock();
160 /* reserve a memory zone for this ring. If we can't get rte_config or
161 * we are secondary process, the memzone_reserve function will set
162 * rte_errno for us appropriately - hence no check in this this function */
163 mz = rte_memzone_reserve_aligned(mz_name, ring_size, socket_id,
164 mz_flags, __alignof__(*r));
167 /* no need to check return value here, we already checked the
169 rte_ring_init(r, name, requested_count, flags);
171 te->data = (void *) r;
174 TAILQ_INSERT_TAIL(ring_list, te, next);
177 RTE_LOG(ERR, RING, "Cannot reserve memory\n");
180 rte_mcfg_tailq_write_unlock();
187 rte_ring_free(struct rte_ring *r)
189 struct rte_ring_list *ring_list = NULL;
190 struct rte_tailq_entry *te;
196 * Ring was not created with rte_ring_create,
197 * therefore, there is no memzone to free.
199 if (r->memzone == NULL) {
201 "Cannot free ring, not created with rte_ring_create()\n");
205 if (rte_memzone_free(r->memzone) != 0) {
206 RTE_LOG(ERR, RING, "Cannot free memory\n");
210 ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
211 rte_mcfg_tailq_write_lock();
213 /* find out tailq entry */
214 TAILQ_FOREACH(te, ring_list, next) {
215 if (te->data == (void *) r)
220 rte_mcfg_tailq_write_unlock();
224 TAILQ_REMOVE(ring_list, te, next);
226 rte_mcfg_tailq_write_unlock();
231 /* dump the status of the ring on the console */
233 rte_ring_dump(FILE *f, const struct rte_ring *r)
235 fprintf(f, "ring <%s>@%p\n", r->name, r);
236 fprintf(f, " flags=%x\n", r->flags);
237 fprintf(f, " size=%"PRIu32"\n", r->size);
238 fprintf(f, " capacity=%"PRIu32"\n", r->capacity);
239 fprintf(f, " ct=%"PRIu32"\n", r->cons.tail);
240 fprintf(f, " ch=%"PRIu32"\n", r->cons.head);
241 fprintf(f, " pt=%"PRIu32"\n", r->prod.tail);
242 fprintf(f, " ph=%"PRIu32"\n", r->prod.head);
243 fprintf(f, " used=%u\n", rte_ring_count(r));
244 fprintf(f, " avail=%u\n", rte_ring_free_count(r));
247 /* dump the status of all rings on the console */
249 rte_ring_list_dump(FILE *f)
251 const struct rte_tailq_entry *te;
252 struct rte_ring_list *ring_list;
254 ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
256 rte_mcfg_tailq_read_lock();
258 TAILQ_FOREACH(te, ring_list, next) {
259 rte_ring_dump(f, (struct rte_ring *) te->data);
262 rte_mcfg_tailq_read_unlock();
265 /* search a ring from its name */
267 rte_ring_lookup(const char *name)
269 struct rte_tailq_entry *te;
270 struct rte_ring *r = NULL;
271 struct rte_ring_list *ring_list;
273 ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
275 rte_mcfg_tailq_read_lock();
277 TAILQ_FOREACH(te, ring_list, next) {
278 r = (struct rte_ring *) te->data;
279 if (strncmp(name, r->name, RTE_RING_NAMESIZE) == 0)
283 rte_mcfg_tailq_read_unlock();