Branch data Line data Source code
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 <stdalign.h>
11 : : #include <stdio.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 <eal_export.h>
19 : : #include <rte_common.h>
20 : : #include <rte_log.h>
21 : : #include <rte_memzone.h>
22 : : #include <rte_malloc.h>
23 : : #include <rte_eal_memconfig.h>
24 : : #include <rte_errno.h>
25 : : #include <rte_string_fns.h>
26 : : #include <rte_tailq.h>
27 : : #include <rte_telemetry.h>
28 : : #include <rte_bitops.h>
29 : :
30 : : #include "rte_ring.h"
31 : : #include "rte_ring_elem.h"
32 : :
33 [ - + ]: 301 : RTE_LOG_REGISTER_DEFAULT(ring_logtype, INFO);
34 : : #define RTE_LOGTYPE_RING ring_logtype
35 : : #define RING_LOG(level, ...) \
36 : : RTE_LOG_LINE(level, RING, "" __VA_ARGS__)
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 [ - + ]: 301 : EAL_REGISTER_TAILQ(rte_ring_tailq)
44 : :
45 : : /* mask of all valid flag values to ring_create() */
46 : : #define RING_F_MASK (RING_F_SP_ENQ | RING_F_SC_DEQ | RING_F_EXACT_SZ | \
47 : : RING_F_MP_RTS_ENQ | RING_F_MC_RTS_DEQ | \
48 : : RING_F_MP_HTS_ENQ | RING_F_MC_HTS_DEQ)
49 : :
50 : : /* by default set head/tail distance as 1/8 of ring capacity */
51 : : #define HTD_MAX_DEF 8
52 : :
53 : : /* return the size of memory occupied by a ring */
54 : : RTE_EXPORT_SYMBOL(rte_ring_get_memsize_elem)
55 : : ssize_t
56 : 4891 : rte_ring_get_memsize_elem(unsigned int esize, unsigned int count)
57 : : {
58 : : ssize_t sz;
59 : :
60 : : /* Check if element size is a multiple of 4B */
61 [ + + ]: 4891 : if (esize % 4 != 0) {
62 : 1 : RING_LOG(ERR, "element size is not a multiple of 4");
63 : :
64 : 1 : return -EINVAL;
65 : : }
66 : :
67 : : /* count must be a power of 2 */
68 [ + + + + : 4890 : if ((!RTE_IS_POWER_OF_2(count)) || (count > RTE_RING_SZ_MASK)) {
+ + ]
69 : 19 : RING_LOG(ERR,
70 : : "Requested number of elements is invalid, must be power of 2, and not exceed %u",
71 : : RTE_RING_SZ_MASK);
72 : :
73 : 19 : return -EINVAL;
74 : : }
75 : :
76 : : static_assert(sizeof(struct rte_ring) == RTE_CACHE_LINE_ROUNDUP(sizeof(struct rte_ring)),
77 : : "Size of struct rte_ring not cache line aligned");
78 : 4871 : sz = sizeof(struct rte_ring) + (ssize_t)count * esize;
79 : : /* Add padding, to guard against false sharing-like effects
80 : : * on systems with a next-N-lines hardware prefetcher, when
81 : : * accessing elements at the end of the ring table.
82 : : */
83 : 4871 : sz = RTE_ALIGN(sz, RTE_CACHE_LINE_SIZE);
84 : 4871 : sz += RTE_CACHE_GUARD_LINES * RTE_CACHE_LINE_SIZE;
85 : 4871 : return sz;
86 : : }
87 : :
88 : : /* return the size of memory occupied by a ring */
89 : : RTE_EXPORT_SYMBOL(rte_ring_get_memsize)
90 : : ssize_t
91 : 0 : rte_ring_get_memsize(unsigned int count)
92 : : {
93 : 0 : return rte_ring_get_memsize_elem(sizeof(void *), count);
94 : : }
95 : :
96 : : /*
97 : : * internal helper function to reset prod/cons head-tail values.
98 : : */
99 : : static void
100 : : reset_headtail(void *p)
101 : : {
102 : : struct rte_ring_headtail *ht;
103 : : struct rte_ring_hts_headtail *ht_hts;
104 : : struct rte_ring_rts_headtail *ht_rts;
105 : :
106 : : ht = p;
107 : : ht_hts = p;
108 : : ht_rts = p;
109 : :
110 : 40 : switch (ht->sync_type) {
111 : 40 : case RTE_RING_SYNC_MT:
112 : : case RTE_RING_SYNC_ST:
113 : 40 : ht->head = 0;
114 : 40 : ht->tail = 0;
115 : 40 : break;
116 : 0 : case RTE_RING_SYNC_MT_RTS:
117 : 0 : ht_rts->head.raw = 0;
118 : 0 : ht_rts->tail.raw = 0;
119 : 0 : break;
120 : 0 : case RTE_RING_SYNC_MT_HTS:
121 : 0 : ht_hts->ht.raw = 0;
122 : 0 : break;
123 [ + - - - ]: 20 : default:
124 : : /* unknown sync mode */
125 : : RTE_ASSERT(0);
126 : : }
127 : : }
128 : :
129 : : RTE_EXPORT_SYMBOL(rte_ring_reset)
130 : : void
131 [ + - - - ]: 20 : rte_ring_reset(struct rte_ring *r)
132 : : {
133 : : reset_headtail(&r->prod);
134 : : reset_headtail(&r->cons);
135 : 20 : }
136 : :
137 : : /*
138 : : * helper function, calculates sync_type values for prod and cons
139 : : * based on input flags. Returns zero at success or negative
140 : : * errno value otherwise.
141 : : */
142 : : static int
143 : 4848 : get_sync_type(uint32_t flags, enum rte_ring_sync_type *prod_st,
144 : : enum rte_ring_sync_type *cons_st)
145 : : {
146 : : static const uint32_t prod_st_flags =
147 : : (RING_F_SP_ENQ | RING_F_MP_RTS_ENQ | RING_F_MP_HTS_ENQ);
148 : : static const uint32_t cons_st_flags =
149 : : (RING_F_SC_DEQ | RING_F_MC_RTS_DEQ | RING_F_MC_HTS_DEQ);
150 : :
151 [ + + + + : 4848 : switch (flags & prod_st_flags) {
- ]
152 : 465 : case 0:
153 : 465 : *prod_st = RTE_RING_SYNC_MT;
154 : 465 : break;
155 : 4249 : case RING_F_SP_ENQ:
156 : 4249 : *prod_st = RTE_RING_SYNC_ST;
157 : 4249 : break;
158 : 54 : case RING_F_MP_RTS_ENQ:
159 : 54 : *prod_st = RTE_RING_SYNC_MT_RTS;
160 : 54 : break;
161 : 80 : case RING_F_MP_HTS_ENQ:
162 : 80 : *prod_st = RTE_RING_SYNC_MT_HTS;
163 : 80 : break;
164 : : default:
165 : : return -EINVAL;
166 : : }
167 : :
168 [ + + + + : 4848 : switch (flags & cons_st_flags) {
- ]
169 : 466 : case 0:
170 : 466 : *cons_st = RTE_RING_SYNC_MT;
171 : 466 : break;
172 : 4245 : case RING_F_SC_DEQ:
173 : 4245 : *cons_st = RTE_RING_SYNC_ST;
174 : 4245 : break;
175 : 40 : case RING_F_MC_RTS_DEQ:
176 : 40 : *cons_st = RTE_RING_SYNC_MT_RTS;
177 : 40 : break;
178 : 97 : case RING_F_MC_HTS_DEQ:
179 : 97 : *cons_st = RTE_RING_SYNC_MT_HTS;
180 : 97 : break;
181 : : default:
182 : : return -EINVAL;
183 : : }
184 : :
185 : : return 0;
186 : : }
187 : :
188 : : RTE_EXPORT_SYMBOL(rte_ring_init)
189 : : int
190 : 4848 : rte_ring_init(struct rte_ring *r, const char *name, unsigned int count,
191 : : unsigned int flags)
192 : : {
193 : : int ret;
194 : :
195 : : /* compilation-time checks */
196 : : RTE_BUILD_BUG_ON((sizeof(struct rte_ring) &
197 : : RTE_CACHE_LINE_MASK) != 0);
198 : : RTE_BUILD_BUG_ON((offsetof(struct rte_ring, cons) &
199 : : RTE_CACHE_LINE_MASK) != 0);
200 : : RTE_BUILD_BUG_ON((offsetof(struct rte_ring, prod) &
201 : : RTE_CACHE_LINE_MASK) != 0);
202 : :
203 : : RTE_BUILD_BUG_ON(offsetof(struct rte_ring_headtail, sync_type) !=
204 : : offsetof(struct rte_ring_hts_headtail, sync_type));
205 : : RTE_BUILD_BUG_ON(offsetof(struct rte_ring_headtail, tail) !=
206 : : offsetof(struct rte_ring_hts_headtail, ht.pos.tail));
207 : :
208 : : RTE_BUILD_BUG_ON(offsetof(struct rte_ring_headtail, sync_type) !=
209 : : offsetof(struct rte_ring_rts_headtail, sync_type));
210 : : RTE_BUILD_BUG_ON(offsetof(struct rte_ring_headtail, tail) !=
211 : : offsetof(struct rte_ring_rts_headtail, tail.val.pos));
212 : :
213 : : /* future proof flags, only allow supported values */
214 [ - + ]: 4848 : if (flags & ~RING_F_MASK) {
215 : 0 : RING_LOG(ERR,
216 : : "Unsupported flags requested %#x", flags);
217 : 0 : return -EINVAL;
218 : : }
219 : :
220 : : /* init the ring structure */
221 : : memset(r, 0, sizeof(*r));
222 [ + - ]: 4848 : ret = strlcpy(r->name, name, sizeof(r->name));
223 [ + - ]: 4848 : if (ret < 0 || ret >= (int)sizeof(r->name))
224 : : return -ENAMETOOLONG;
225 : 4848 : r->flags = flags;
226 : 4848 : ret = get_sync_type(flags, &r->prod.sync_type, &r->cons.sync_type);
227 [ + - ]: 4848 : if (ret != 0)
228 : : return ret;
229 : :
230 [ + + ]: 4848 : if (flags & RING_F_EXACT_SZ) {
231 : 238 : r->size = rte_align32pow2(count + 1);
232 : 238 : r->mask = r->size - 1;
233 : 238 : r->capacity = count;
234 : : } else {
235 [ + - + - : 4610 : if ((!RTE_IS_POWER_OF_2(count)) || (count > RTE_RING_SZ_MASK)) {
- + ]
236 : 0 : RING_LOG(ERR,
237 : : "Requested size is invalid, must be power of 2, and not exceed the size limit %u",
238 : : RTE_RING_SZ_MASK);
239 : 0 : return -EINVAL;
240 : : }
241 : 4610 : r->size = count;
242 : 4610 : r->mask = count - 1;
243 : 4610 : r->capacity = r->mask;
244 : : }
245 : :
246 : : /* set default values for head-tail distance */
247 [ + + ]: 4848 : if (flags & RING_F_MP_RTS_ENQ)
248 [ + - ]: 54 : rte_ring_set_prod_htd_max(r, r->capacity / HTD_MAX_DEF);
249 [ + + ]: 4848 : if (flags & RING_F_MC_RTS_DEQ)
250 [ + - ]: 40 : rte_ring_set_cons_htd_max(r, r->capacity / HTD_MAX_DEF);
251 : :
252 : : return 0;
253 : : }
254 : :
255 : : /* create the ring for a given element size */
256 : : RTE_EXPORT_SYMBOL(rte_ring_create_elem)
257 : : struct rte_ring *
258 : 4892 : rte_ring_create_elem(const char *name, unsigned int esize, unsigned int count,
259 : : int socket_id, unsigned int flags)
260 : : {
261 : : char mz_name[RTE_MEMZONE_NAMESIZE];
262 : : struct rte_ring *r;
263 : : struct rte_tailq_entry *te;
264 : : const struct rte_memzone *mz;
265 : : ssize_t ring_size;
266 : : int mz_flags = 0;
267 : : struct rte_ring_list* ring_list = NULL;
268 : : const unsigned int requested_count = count;
269 : : int ret;
270 : :
271 : 4892 : ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
272 : :
273 : : /* for an exact size ring, round up from count to a power of two */
274 [ + + ]: 4892 : if (flags & RING_F_EXACT_SZ)
275 : : count = rte_align32pow2(count + 1);
276 : :
277 : 4892 : ring_size = rte_ring_get_memsize_elem(esize, count);
278 [ + + ]: 4889 : if (ring_size < 0) {
279 : 20 : rte_errno = -ring_size;
280 : 20 : return NULL;
281 : : }
282 : :
283 : : ret = snprintf(mz_name, sizeof(mz_name), "%s%s",
284 : : RTE_RING_MZ_PREFIX, name);
285 [ - + ]: 4869 : if (ret < 0 || ret >= (int)sizeof(mz_name)) {
286 : 0 : rte_errno = ENAMETOOLONG;
287 : 0 : return NULL;
288 : : }
289 : :
290 : 4869 : te = rte_zmalloc("RING_TAILQ_ENTRY", sizeof(*te), 0);
291 [ - + ]: 4872 : if (te == NULL) {
292 : 0 : RING_LOG(ERR, "Cannot reserve memory for tailq");
293 : 0 : rte_errno = ENOMEM;
294 : 0 : return NULL;
295 : : }
296 : :
297 : 4872 : rte_mcfg_tailq_write_lock();
298 : :
299 : : /* reserve a memory zone for this ring. If we can't get rte_config or
300 : : * we are secondary process, the memzone_reserve function will set
301 : : * rte_errno for us appropriately - hence no check in this function
302 : : */
303 : 4872 : mz = rte_memzone_reserve_aligned(mz_name, ring_size, socket_id,
304 : : mz_flags, alignof(typeof(*r)));
305 [ + + ]: 4872 : if (mz != NULL) {
306 : 4848 : r = mz->addr;
307 : : /* no need to check return value here, we already checked the
308 : : * arguments above */
309 : 4848 : rte_ring_init(r, name, requested_count, flags);
310 : :
311 : 4848 : te->data = (void *) r;
312 : 4848 : r->memzone = mz;
313 : :
314 : 4848 : TAILQ_INSERT_TAIL(ring_list, te, next);
315 : : } else {
316 : : r = NULL;
317 : 24 : RING_LOG(ERR, "Cannot reserve memory");
318 : 24 : rte_free(te);
319 : : }
320 : 4872 : rte_mcfg_tailq_write_unlock();
321 : :
322 : 4872 : return r;
323 : : }
324 : :
325 : : /* create the ring */
326 : : RTE_EXPORT_SYMBOL(rte_ring_create)
327 : : struct rte_ring *
328 : 4138 : rte_ring_create(const char *name, unsigned int count, int socket_id,
329 : : unsigned int flags)
330 : : {
331 : 4138 : return rte_ring_create_elem(name, sizeof(void *), count, socket_id,
332 : : flags);
333 : : }
334 : :
335 : : /* free the ring */
336 : : RTE_EXPORT_SYMBOL(rte_ring_free)
337 : : void
338 : 5238 : rte_ring_free(struct rte_ring *r)
339 : : {
340 : : struct rte_ring_list *ring_list = NULL;
341 : : struct rte_tailq_entry *te;
342 : :
343 [ + + ]: 5238 : if (r == NULL)
344 : : return;
345 : :
346 : : /*
347 : : * Ring was not created with rte_ring_create,
348 : : * therefore, there is no memzone to free.
349 : : */
350 [ - + ]: 4807 : if (r->memzone == NULL) {
351 : 0 : RING_LOG(ERR,
352 : : "Cannot free ring, not created with rte_ring_create()");
353 : 0 : return;
354 : : }
355 : :
356 : 4807 : ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
357 : 4807 : rte_mcfg_tailq_write_lock();
358 : :
359 : : /* find out tailq entry */
360 [ + - ]: 20895 : TAILQ_FOREACH(te, ring_list, next) {
361 [ + + ]: 20895 : if (te->data == (void *) r)
362 : : break;
363 : : }
364 : :
365 [ - + ]: 4807 : if (te == NULL) {
366 : 0 : rte_mcfg_tailq_write_unlock();
367 : 0 : return;
368 : : }
369 : :
370 [ + + ]: 4807 : TAILQ_REMOVE(ring_list, te, next);
371 : :
372 : 4807 : rte_mcfg_tailq_write_unlock();
373 : :
374 [ - + ]: 4807 : if (rte_memzone_free(r->memzone) != 0)
375 : 0 : RING_LOG(ERR, "Cannot free memory");
376 : :
377 : 4807 : rte_free(te);
378 : : }
379 : :
380 : : static const char *
381 : : ring_get_sync_type(const enum rte_ring_sync_type st)
382 : : {
383 : 10 : switch (st) {
384 : : case RTE_RING_SYNC_ST:
385 : : return "ST";
386 : 5 : case RTE_RING_SYNC_MT:
387 : 5 : return "MT";
388 : 0 : case RTE_RING_SYNC_MT_RTS:
389 : 0 : return "MT_RTS";
390 : 2 : case RTE_RING_SYNC_MT_HTS:
391 : 2 : return "MT_HTS";
392 : 0 : default:
393 : 0 : return "unknown";
394 : : }
395 : : }
396 : :
397 : : static void
398 : 8 : ring_dump_ht_headtail(FILE *f, const char *prefix,
399 : : const struct rte_ring_headtail *ht)
400 : : {
401 : : fprintf(f, "%ssync_type=%s\n", prefix,
402 [ + - - - : 8 : ring_get_sync_type(ht->sync_type));
+ ]
403 : 8 : fprintf(f, "%shead=%"PRIu32"\n", prefix, ht->head);
404 : 8 : fprintf(f, "%stail=%"PRIu32"\n", prefix, ht->tail);
405 : 8 : }
406 : :
407 : : static void
408 : 0 : ring_dump_rts_headtail(FILE *f, const char *prefix,
409 : : const struct rte_ring_rts_headtail *rts)
410 : : {
411 : : fprintf(f, "%ssync_type=%s\n", prefix,
412 [ # # # # : 0 : ring_get_sync_type(rts->sync_type));
# ]
413 : 0 : fprintf(f, "%shead.pos=%"PRIu32"\n", prefix, rts->head.val.pos);
414 : 0 : fprintf(f, "%shead.cnt=%"PRIu32"\n", prefix, rts->head.val.cnt);
415 : 0 : fprintf(f, "%stail.pos=%"PRIu32"\n", prefix, rts->tail.val.pos);
416 : 0 : fprintf(f, "%stail.cnt=%"PRIu32"\n", prefix, rts->tail.val.cnt);
417 : 0 : fprintf(f, "%shtd_max=%"PRIu32"\n", prefix, rts->htd_max);
418 : 0 : }
419 : :
420 : : static void
421 : 2 : ring_dump_hts_headtail(FILE *f, const char *prefix,
422 : : const struct rte_ring_hts_headtail *hts)
423 : : {
424 : : fprintf(f, "%ssync_type=%s\n", prefix,
425 [ - - + - : 2 : ring_get_sync_type(hts->sync_type));
- ]
426 : 2 : fprintf(f, "%shead=%"PRIu32"\n", prefix, hts->ht.pos.head);
427 : 2 : fprintf(f, "%stail=%"PRIu32"\n", prefix, hts->ht.pos.tail);
428 : 2 : }
429 : :
430 : : RTE_EXPORT_EXPERIMENTAL_SYMBOL(rte_ring_headtail_dump, 25.03)
431 : : void
432 : 10 : rte_ring_headtail_dump(FILE *f, const char *prefix,
433 : : const struct rte_ring_headtail *r)
434 : : {
435 [ + - ]: 10 : if (f == NULL || r == NULL)
436 : : return;
437 : :
438 [ - + ]: 10 : prefix = (prefix != NULL) ? prefix : "";
439 : :
440 [ + - + - ]: 10 : switch (r->sync_type) {
441 : 8 : case RTE_RING_SYNC_ST:
442 : : case RTE_RING_SYNC_MT:
443 : 8 : ring_dump_ht_headtail(f, prefix, r);
444 : 8 : break;
445 : 0 : case RTE_RING_SYNC_MT_RTS:
446 : 0 : ring_dump_rts_headtail(f, prefix,
447 : : (const struct rte_ring_rts_headtail *)r);
448 : 0 : break;
449 : 2 : case RTE_RING_SYNC_MT_HTS:
450 : 2 : ring_dump_hts_headtail(f, prefix,
451 : : (const struct rte_ring_hts_headtail *)r);
452 : 2 : break;
453 : 0 : default:
454 : 0 : RING_LOG(ERR, "Invalid ring sync type detected");
455 : : }
456 : : }
457 : :
458 : : /* dump the status of the ring on the console */
459 : : RTE_EXPORT_SYMBOL(rte_ring_dump)
460 : : void
461 : 1 : rte_ring_dump(FILE *f, const struct rte_ring *r)
462 : : {
463 [ + - ]: 1 : if (f == NULL || r == NULL)
464 : : return;
465 : :
466 : 1 : fprintf(f, "ring <%s>@%p\n", r->name, r);
467 : 1 : fprintf(f, " flags=%x\n", r->flags);
468 : 1 : fprintf(f, " size=%"PRIu32"\n", r->size);
469 : 1 : fprintf(f, " capacity=%"PRIu32"\n", r->capacity);
470 : : fprintf(f, " used=%u\n", rte_ring_count(r));
471 : : fprintf(f, " avail=%u\n", rte_ring_free_count(r));
472 : :
473 : 1 : rte_ring_headtail_dump(f, " cons.", &(r->cons));
474 : 1 : rte_ring_headtail_dump(f, " prod.", &(r->prod));
475 : : }
476 : :
477 : : /* dump the status of all rings on the console */
478 : : RTE_EXPORT_SYMBOL(rte_ring_list_dump)
479 : : void
480 : 1 : rte_ring_list_dump(FILE *f)
481 : : {
482 : : const struct rte_tailq_entry *te;
483 : : struct rte_ring_list *ring_list;
484 : :
485 : 1 : ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
486 : :
487 : 1 : rte_mcfg_tailq_read_lock();
488 : :
489 [ - + ]: 1 : TAILQ_FOREACH(te, ring_list, next) {
490 : 0 : rte_ring_dump(f, (struct rte_ring *) te->data);
491 : : }
492 : :
493 : 1 : rte_mcfg_tailq_read_unlock();
494 : 1 : }
495 : :
496 : : /* search a ring from its name */
497 : : RTE_EXPORT_SYMBOL(rte_ring_lookup)
498 : : struct rte_ring *
499 : 4135 : rte_ring_lookup(const char *name)
500 : : {
501 : : struct rte_tailq_entry *te;
502 : : struct rte_ring *r = NULL;
503 : : struct rte_ring_list *ring_list;
504 : :
505 : 4135 : ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
506 : :
507 : 4135 : rte_mcfg_tailq_read_lock();
508 : :
509 [ + + ]: 47800 : TAILQ_FOREACH(te, ring_list, next) {
510 : 43854 : r = (struct rte_ring *) te->data;
511 [ + + ]: 43854 : if (strncmp(name, r->name, RTE_RING_NAMESIZE) == 0)
512 : : break;
513 : : }
514 : :
515 : 4131 : rte_mcfg_tailq_read_unlock();
516 : :
517 [ + + ]: 4133 : if (te == NULL) {
518 : 3952 : rte_errno = ENOENT;
519 : 3952 : return NULL;
520 : : }
521 : :
522 : : return r;
523 : : }
524 : :
525 : : static void
526 : 5 : ring_walk(void (*func)(struct rte_ring *, void *), void *arg)
527 : : {
528 : : struct rte_ring_list *ring_list;
529 : : struct rte_tailq_entry *tailq_entry;
530 : :
531 : 5 : ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
532 : 5 : rte_mcfg_tailq_read_lock();
533 : :
534 [ - + ]: 5 : TAILQ_FOREACH(tailq_entry, ring_list, next) {
535 : 0 : (*func)((struct rte_ring *) tailq_entry->data, arg);
536 : : }
537 : :
538 : 5 : rte_mcfg_tailq_read_unlock();
539 : 5 : }
540 : :
541 : : static void
542 : 0 : ring_list_cb(struct rte_ring *r, void *arg)
543 : : {
544 : : struct rte_tel_data *d = (struct rte_tel_data *)arg;
545 : :
546 : 0 : rte_tel_data_add_array_string(d, r->name);
547 : 0 : }
548 : :
549 : : static int
550 : 3 : ring_handle_list(const char *cmd __rte_unused,
551 : : const char *params __rte_unused, struct rte_tel_data *d)
552 : : {
553 : 3 : rte_tel_data_start_array(d, RTE_TEL_STRING_VAL);
554 : 3 : ring_walk(ring_list_cb, d);
555 : 3 : return 0;
556 : : }
557 : :
558 : : static const char *
559 : : ring_prod_sync_type_to_name(struct rte_ring *r)
560 : : {
561 [ # # # # : 0 : switch (r->prod.sync_type) {
# ]
562 : : case RTE_RING_SYNC_MT:
563 : : return "MP";
564 : 0 : case RTE_RING_SYNC_ST:
565 : 0 : return "SP";
566 : 0 : case RTE_RING_SYNC_MT_RTS:
567 : 0 : return "MP_RTS";
568 : 0 : case RTE_RING_SYNC_MT_HTS:
569 : 0 : return "MP_HTS";
570 : 0 : default:
571 : 0 : return "Unknown";
572 : : }
573 : : }
574 : :
575 : : static const char *
576 : : ring_cons_sync_type_to_name(struct rte_ring *r)
577 : : {
578 [ # # # # : 0 : switch (r->cons.sync_type) {
# ]
579 : : case RTE_RING_SYNC_MT:
580 : : return "MC";
581 : 0 : case RTE_RING_SYNC_ST:
582 : 0 : return "SC";
583 : 0 : case RTE_RING_SYNC_MT_RTS:
584 : 0 : return "MC_RTS";
585 : 0 : case RTE_RING_SYNC_MT_HTS:
586 : 0 : return "MC_HTS";
587 : 0 : default:
588 : 0 : return "Unknown";
589 : : }
590 : : }
591 : :
592 : : struct ring_info_cb_arg {
593 : : char *ring_name;
594 : : struct rte_tel_data *d;
595 : : };
596 : :
597 : : static void
598 : 0 : ring_info_cb(struct rte_ring *r, void *arg)
599 : : {
600 : : struct ring_info_cb_arg *ring_arg = (struct ring_info_cb_arg *)arg;
601 : 0 : struct rte_tel_data *d = ring_arg->d;
602 : : const struct rte_memzone *mz;
603 : :
604 [ # # ]: 0 : if (strncmp(r->name, ring_arg->ring_name, RTE_RING_NAMESIZE))
605 : : return;
606 : :
607 : 0 : rte_tel_data_add_dict_string(d, "name", r->name);
608 : 0 : rte_tel_data_add_dict_int(d, "socket", r->memzone->socket_id);
609 : 0 : rte_tel_data_add_dict_int(d, "flags", r->flags);
610 : 0 : rte_tel_data_add_dict_string(d, "producer_type",
611 : : ring_prod_sync_type_to_name(r));
612 : 0 : rte_tel_data_add_dict_string(d, "consumer_type",
613 : : ring_cons_sync_type_to_name(r));
614 : 0 : rte_tel_data_add_dict_uint(d, "size", r->size);
615 : 0 : rte_tel_data_add_dict_uint_hex(d, "mask", r->mask, 0);
616 : 0 : rte_tel_data_add_dict_uint(d, "capacity", r->capacity);
617 : 0 : rte_tel_data_add_dict_uint(d, "used_count", rte_ring_count(r));
618 : :
619 : 0 : mz = r->memzone;
620 [ # # ]: 0 : if (mz == NULL)
621 : : return;
622 : 0 : rte_tel_data_add_dict_string(d, "mz_name", mz->name);
623 : 0 : rte_tel_data_add_dict_uint(d, "mz_len", mz->len);
624 : 0 : rte_tel_data_add_dict_uint(d, "mz_hugepage_sz", mz->hugepage_sz);
625 : 0 : rte_tel_data_add_dict_int(d, "mz_socket_id", mz->socket_id);
626 : 0 : rte_tel_data_add_dict_uint_hex(d, "mz_flags", mz->flags, 0);
627 : : }
628 : :
629 : : static int
630 : 3 : ring_handle_info(const char *cmd __rte_unused, const char *params,
631 : : struct rte_tel_data *d)
632 : : {
633 : 3 : char name[RTE_RING_NAMESIZE] = {0};
634 : : struct ring_info_cb_arg ring_arg;
635 : :
636 [ + + + - ]: 3 : if (params == NULL || strlen(params) == 0 ||
637 [ + - ]: 2 : strlen(params) >= RTE_RING_NAMESIZE)
638 : : return -EINVAL;
639 : :
640 : : rte_strlcpy(name, params, RTE_RING_NAMESIZE);
641 : :
642 : 2 : ring_arg.ring_name = name;
643 : 2 : ring_arg.d = d;
644 : :
645 : 2 : rte_tel_data_start_dict(d);
646 : 2 : ring_walk(ring_info_cb, &ring_arg);
647 : :
648 : 2 : return 0;
649 : : }
650 : :
651 : 301 : RTE_INIT(ring_init_telemetry)
652 : : {
653 : 301 : rte_telemetry_register_cmd("/ring/list", ring_handle_list,
654 : : "Returns list of available rings. Takes no parameters");
655 : 301 : rte_telemetry_register_cmd("/ring/info", ring_handle_info,
656 : : "Returns ring info. Parameters: ring_name.");
657 : 301 : }
|
