LCOV - code coverage report
Current view: top level - lib/ring - rte_ring.c (source / functions) Hit Total Coverage
Test: Code coverage Lines: 132 216 61.1 %
Date: 2025-01-02 22:41:34 Functions: 13 19 68.4 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 57 104 54.8 %

           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 <rte_common.h>
      19                 :            : #include <rte_log.h>
      20                 :            : #include <rte_memzone.h>
      21                 :            : #include <rte_malloc.h>
      22                 :            : #include <rte_eal_memconfig.h>
      23                 :            : #include <rte_errno.h>
      24                 :            : #include <rte_string_fns.h>
      25                 :            : #include <rte_tailq.h>
      26                 :            : #include <rte_telemetry.h>
      27                 :            : 
      28                 :            : #include "rte_ring.h"
      29                 :            : #include "rte_ring_elem.h"
      30                 :            : 
      31         [ -  + ]:        251 : RTE_LOG_REGISTER_DEFAULT(ring_logtype, INFO);
      32                 :            : #define RTE_LOGTYPE_RING ring_logtype
      33                 :            : #define RING_LOG(level, ...) \
      34                 :            :         RTE_LOG_LINE(level, RING, "" __VA_ARGS__)
      35                 :            : 
      36                 :            : TAILQ_HEAD(rte_ring_list, rte_tailq_entry);
      37                 :            : 
      38                 :            : static struct rte_tailq_elem rte_ring_tailq = {
      39                 :            :         .name = RTE_TAILQ_RING_NAME,
      40                 :            : };
      41         [ -  + ]:        251 : EAL_REGISTER_TAILQ(rte_ring_tailq)
      42                 :            : 
      43                 :            : /* mask of all valid flag values to ring_create() */
      44                 :            : #define RING_F_MASK (RING_F_SP_ENQ | RING_F_SC_DEQ | RING_F_EXACT_SZ | \
      45                 :            :                      RING_F_MP_RTS_ENQ | RING_F_MC_RTS_DEQ |           \
      46                 :            :                      RING_F_MP_HTS_ENQ | RING_F_MC_HTS_DEQ)
      47                 :            : 
      48                 :            : /* true if x is a power of 2 */
      49                 :            : #define POWEROF2(x) ((((x)-1) & (x)) == 0)
      50                 :            : 
      51                 :            : /* by default set head/tail distance as 1/8 of ring capacity */
      52                 :            : #define HTD_MAX_DEF     8
      53                 :            : 
      54                 :            : /* return the size of memory occupied by a ring */
      55                 :            : ssize_t
      56                 :       4644 : 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         [ +  + ]:       4644 :         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   [ +  +  +  + ]:       4643 :         if ((!POWEROF2(count)) || (count > RTE_RING_SZ_MASK )) {
      69                 :         18 :                 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                 :         18 :                 return -EINVAL;
      74                 :            :         }
      75                 :            : 
      76                 :       4625 :         sz = sizeof(struct rte_ring) + (ssize_t)count * esize;
      77                 :       4625 :         sz = RTE_ALIGN(sz, RTE_CACHE_LINE_SIZE);
      78                 :       4625 :         return sz;
      79                 :            : }
      80                 :            : 
      81                 :            : /* return the size of memory occupied by a ring */
      82                 :            : ssize_t
      83                 :          0 : rte_ring_get_memsize(unsigned int count)
      84                 :            : {
      85                 :          0 :         return rte_ring_get_memsize_elem(sizeof(void *), count);
      86                 :            : }
      87                 :            : 
      88                 :            : /*
      89                 :            :  * internal helper function to reset prod/cons head-tail values.
      90                 :            :  */
      91                 :            : static void
      92                 :            : reset_headtail(void *p)
      93                 :            : {
      94                 :            :         struct rte_ring_headtail *ht;
      95                 :            :         struct rte_ring_hts_headtail *ht_hts;
      96                 :            :         struct rte_ring_rts_headtail *ht_rts;
      97                 :            : 
      98                 :            :         ht = p;
      99                 :            :         ht_hts = p;
     100                 :            :         ht_rts = p;
     101                 :            : 
     102                 :         40 :         switch (ht->sync_type) {
     103                 :         40 :         case RTE_RING_SYNC_MT:
     104                 :            :         case RTE_RING_SYNC_ST:
     105                 :         40 :                 ht->head = 0;
     106                 :         40 :                 ht->tail = 0;
     107                 :         40 :                 break;
     108                 :          0 :         case RTE_RING_SYNC_MT_RTS:
     109                 :          0 :                 ht_rts->head.raw = 0;
     110                 :          0 :                 ht_rts->tail.raw = 0;
     111                 :          0 :                 break;
     112                 :          0 :         case RTE_RING_SYNC_MT_HTS:
     113                 :          0 :                 ht_hts->ht.raw = 0;
     114                 :          0 :                 break;
     115   [ +  -  -  - ]:         20 :         default:
     116                 :            :                 /* unknown sync mode */
     117                 :            :                 RTE_ASSERT(0);
     118                 :            :         }
     119                 :            : }
     120                 :            : 
     121                 :            : void
     122   [ +  -  -  - ]:         20 : rte_ring_reset(struct rte_ring *r)
     123                 :            : {
     124                 :            :         reset_headtail(&r->prod);
     125                 :            :         reset_headtail(&r->cons);
     126                 :         20 : }
     127                 :            : 
     128                 :            : /*
     129                 :            :  * helper function, calculates sync_type values for prod and cons
     130                 :            :  * based on input flags. Returns zero at success or negative
     131                 :            :  * errno value otherwise.
     132                 :            :  */
     133                 :            : static int
     134                 :       4602 : get_sync_type(uint32_t flags, enum rte_ring_sync_type *prod_st,
     135                 :            :         enum rte_ring_sync_type *cons_st)
     136                 :            : {
     137                 :            :         static const uint32_t prod_st_flags =
     138                 :            :                 (RING_F_SP_ENQ | RING_F_MP_RTS_ENQ | RING_F_MP_HTS_ENQ);
     139                 :            :         static const uint32_t cons_st_flags =
     140                 :            :                 (RING_F_SC_DEQ | RING_F_MC_RTS_DEQ | RING_F_MC_HTS_DEQ);
     141                 :            : 
     142   [ +  +  +  +  :       4602 :         switch (flags & prod_st_flags) {
                      - ]
     143                 :        351 :         case 0:
     144                 :        351 :                 *prod_st = RTE_RING_SYNC_MT;
     145                 :        351 :                 break;
     146                 :       4119 :         case RING_F_SP_ENQ:
     147                 :       4119 :                 *prod_st = RTE_RING_SYNC_ST;
     148                 :       4119 :                 break;
     149                 :         52 :         case RING_F_MP_RTS_ENQ:
     150                 :         52 :                 *prod_st = RTE_RING_SYNC_MT_RTS;
     151                 :         52 :                 break;
     152                 :         80 :         case RING_F_MP_HTS_ENQ:
     153                 :         80 :                 *prod_st = RTE_RING_SYNC_MT_HTS;
     154                 :         80 :                 break;
     155                 :            :         default:
     156                 :            :                 return -EINVAL;
     157                 :            :         }
     158                 :            : 
     159   [ +  +  +  +  :       4602 :         switch (flags & cons_st_flags) {
                      - ]
     160                 :        352 :         case 0:
     161                 :        352 :                 *cons_st = RTE_RING_SYNC_MT;
     162                 :        352 :                 break;
     163                 :       4115 :         case RING_F_SC_DEQ:
     164                 :       4115 :                 *cons_st = RTE_RING_SYNC_ST;
     165                 :       4115 :                 break;
     166                 :         40 :         case RING_F_MC_RTS_DEQ:
     167                 :         40 :                 *cons_st = RTE_RING_SYNC_MT_RTS;
     168                 :         40 :                 break;
     169                 :         95 :         case RING_F_MC_HTS_DEQ:
     170                 :         95 :                 *cons_st = RTE_RING_SYNC_MT_HTS;
     171                 :         95 :                 break;
     172                 :            :         default:
     173                 :            :                 return -EINVAL;
     174                 :            :         }
     175                 :            : 
     176                 :            :         return 0;
     177                 :            : }
     178                 :            : 
     179                 :            : int
     180                 :       4602 : rte_ring_init(struct rte_ring *r, const char *name, unsigned int count,
     181                 :            :         unsigned int flags)
     182                 :            : {
     183                 :            :         int ret;
     184                 :            : 
     185                 :            :         /* compilation-time checks */
     186                 :            :         RTE_BUILD_BUG_ON((sizeof(struct rte_ring) &
     187                 :            :                           RTE_CACHE_LINE_MASK) != 0);
     188                 :            :         RTE_BUILD_BUG_ON((offsetof(struct rte_ring, cons) &
     189                 :            :                           RTE_CACHE_LINE_MASK) != 0);
     190                 :            :         RTE_BUILD_BUG_ON((offsetof(struct rte_ring, prod) &
     191                 :            :                           RTE_CACHE_LINE_MASK) != 0);
     192                 :            : 
     193                 :            :         RTE_BUILD_BUG_ON(offsetof(struct rte_ring_headtail, sync_type) !=
     194                 :            :                 offsetof(struct rte_ring_hts_headtail, sync_type));
     195                 :            :         RTE_BUILD_BUG_ON(offsetof(struct rte_ring_headtail, tail) !=
     196                 :            :                 offsetof(struct rte_ring_hts_headtail, ht.pos.tail));
     197                 :            : 
     198                 :            :         RTE_BUILD_BUG_ON(offsetof(struct rte_ring_headtail, sync_type) !=
     199                 :            :                 offsetof(struct rte_ring_rts_headtail, sync_type));
     200                 :            :         RTE_BUILD_BUG_ON(offsetof(struct rte_ring_headtail, tail) !=
     201                 :            :                 offsetof(struct rte_ring_rts_headtail, tail.val.pos));
     202                 :            : 
     203                 :            :         /* future proof flags, only allow supported values */
     204         [ -  + ]:       4602 :         if (flags & ~RING_F_MASK) {
     205                 :          0 :                 RING_LOG(ERR,
     206                 :            :                         "Unsupported flags requested %#x", flags);
     207                 :          0 :                 return -EINVAL;
     208                 :            :         }
     209                 :            : 
     210                 :            :         /* init the ring structure */
     211                 :            :         memset(r, 0, sizeof(*r));
     212         [ +  - ]:       4602 :         ret = strlcpy(r->name, name, sizeof(r->name));
     213         [ +  - ]:       4602 :         if (ret < 0 || ret >= (int)sizeof(r->name))
     214                 :            :                 return -ENAMETOOLONG;
     215                 :       4602 :         r->flags = flags;
     216                 :       4602 :         ret = get_sync_type(flags, &r->prod.sync_type, &r->cons.sync_type);
     217         [ +  - ]:       4602 :         if (ret != 0)
     218                 :            :                 return ret;
     219                 :            : 
     220         [ +  + ]:       4602 :         if (flags & RING_F_EXACT_SZ) {
     221                 :        238 :                 r->size = rte_align32pow2(count + 1);
     222                 :        238 :                 r->mask = r->size - 1;
     223                 :        238 :                 r->capacity = count;
     224                 :            :         } else {
     225   [ +  -  -  + ]:       4364 :                 if ((!POWEROF2(count)) || (count > RTE_RING_SZ_MASK)) {
     226                 :          0 :                         RING_LOG(ERR,
     227                 :            :                                 "Requested size is invalid, must be power of 2, and not exceed the size limit %u",
     228                 :            :                                 RTE_RING_SZ_MASK);
     229                 :          0 :                         return -EINVAL;
     230                 :            :                 }
     231                 :       4364 :                 r->size = count;
     232                 :       4364 :                 r->mask = count - 1;
     233                 :       4364 :                 r->capacity = r->mask;
     234                 :            :         }
     235                 :            : 
     236                 :            :         /* set default values for head-tail distance */
     237         [ +  + ]:       4602 :         if (flags & RING_F_MP_RTS_ENQ)
     238         [ +  - ]:         52 :                 rte_ring_set_prod_htd_max(r, r->capacity / HTD_MAX_DEF);
     239         [ +  + ]:       4602 :         if (flags & RING_F_MC_RTS_DEQ)
     240         [ +  - ]:         40 :                 rte_ring_set_cons_htd_max(r, r->capacity / HTD_MAX_DEF);
     241                 :            : 
     242                 :            :         return 0;
     243                 :            : }
     244                 :            : 
     245                 :            : /* create the ring for a given element size */
     246                 :            : struct rte_ring *
     247                 :       4644 : rte_ring_create_elem(const char *name, unsigned int esize, unsigned int count,
     248                 :            :                 int socket_id, unsigned int flags)
     249                 :            : {
     250                 :            :         char mz_name[RTE_MEMZONE_NAMESIZE];
     251                 :            :         struct rte_ring *r;
     252                 :            :         struct rte_tailq_entry *te;
     253                 :            :         const struct rte_memzone *mz;
     254                 :            :         ssize_t ring_size;
     255                 :            :         int mz_flags = 0;
     256                 :            :         struct rte_ring_list* ring_list = NULL;
     257                 :            :         const unsigned int requested_count = count;
     258                 :            :         int ret;
     259                 :            : 
     260                 :       4644 :         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
     261                 :            : 
     262                 :            :         /* for an exact size ring, round up from count to a power of two */
     263         [ +  + ]:       4644 :         if (flags & RING_F_EXACT_SZ)
     264                 :            :                 count = rte_align32pow2(count + 1);
     265                 :            : 
     266                 :       4644 :         ring_size = rte_ring_get_memsize_elem(esize, count);
     267         [ +  + ]:       4644 :         if (ring_size < 0) {
     268                 :         19 :                 rte_errno = -ring_size;
     269                 :         19 :                 return NULL;
     270                 :            :         }
     271                 :            : 
     272                 :            :         ret = snprintf(mz_name, sizeof(mz_name), "%s%s",
     273                 :            :                 RTE_RING_MZ_PREFIX, name);
     274         [ -  + ]:       4625 :         if (ret < 0 || ret >= (int)sizeof(mz_name)) {
     275                 :          0 :                 rte_errno = ENAMETOOLONG;
     276                 :          0 :                 return NULL;
     277                 :            :         }
     278                 :            : 
     279                 :       4625 :         te = rte_zmalloc("RING_TAILQ_ENTRY", sizeof(*te), 0);
     280         [ -  + ]:       4625 :         if (te == NULL) {
     281                 :          0 :                 RING_LOG(ERR, "Cannot reserve memory for tailq");
     282                 :          0 :                 rte_errno = ENOMEM;
     283                 :          0 :                 return NULL;
     284                 :            :         }
     285                 :            : 
     286                 :       4625 :         rte_mcfg_tailq_write_lock();
     287                 :            : 
     288                 :            :         /* reserve a memory zone for this ring. If we can't get rte_config or
     289                 :            :          * we are secondary process, the memzone_reserve function will set
     290                 :            :          * rte_errno for us appropriately - hence no check in this function
     291                 :            :          */
     292                 :       4625 :         mz = rte_memzone_reserve_aligned(mz_name, ring_size, socket_id,
     293                 :            :                                          mz_flags, alignof(typeof(*r)));
     294         [ +  + ]:       4625 :         if (mz != NULL) {
     295                 :       4602 :                 r = mz->addr;
     296                 :            :                 /* no need to check return value here, we already checked the
     297                 :            :                  * arguments above */
     298                 :       4602 :                 rte_ring_init(r, name, requested_count, flags);
     299                 :            : 
     300                 :       4602 :                 te->data = (void *) r;
     301                 :       4602 :                 r->memzone = mz;
     302                 :            : 
     303                 :       4602 :                 TAILQ_INSERT_TAIL(ring_list, te, next);
     304                 :            :         } else {
     305                 :            :                 r = NULL;
     306                 :         23 :                 RING_LOG(ERR, "Cannot reserve memory");
     307                 :         23 :                 rte_free(te);
     308                 :            :         }
     309                 :       4625 :         rte_mcfg_tailq_write_unlock();
     310                 :            : 
     311                 :       4625 :         return r;
     312                 :            : }
     313                 :            : 
     314                 :            : /* create the ring */
     315                 :            : struct rte_ring *
     316                 :       3995 : rte_ring_create(const char *name, unsigned int count, int socket_id,
     317                 :            :                 unsigned int flags)
     318                 :            : {
     319                 :       3995 :         return rte_ring_create_elem(name, sizeof(void *), count, socket_id,
     320                 :            :                 flags);
     321                 :            : }
     322                 :            : 
     323                 :            : /* free the ring */
     324                 :            : void
     325                 :       4888 : rte_ring_free(struct rte_ring *r)
     326                 :            : {
     327                 :            :         struct rte_ring_list *ring_list = NULL;
     328                 :            :         struct rte_tailq_entry *te;
     329                 :            : 
     330         [ +  + ]:       4888 :         if (r == NULL)
     331                 :            :                 return;
     332                 :            : 
     333                 :            :         /*
     334                 :            :          * Ring was not created with rte_ring_create,
     335                 :            :          * therefore, there is no memzone to free.
     336                 :            :          */
     337         [ -  + ]:       4561 :         if (r->memzone == NULL) {
     338                 :          0 :                 RING_LOG(ERR,
     339                 :            :                         "Cannot free ring, not created with rte_ring_create()");
     340                 :          0 :                 return;
     341                 :            :         }
     342                 :            : 
     343                 :       4561 :         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
     344                 :       4561 :         rte_mcfg_tailq_write_lock();
     345                 :            : 
     346                 :            :         /* find out tailq entry */
     347         [ +  - ]:      20278 :         TAILQ_FOREACH(te, ring_list, next) {
     348         [ +  + ]:      20278 :                 if (te->data == (void *) r)
     349                 :            :                         break;
     350                 :            :         }
     351                 :            : 
     352         [ -  + ]:       4561 :         if (te == NULL) {
     353                 :          0 :                 rte_mcfg_tailq_write_unlock();
     354                 :          0 :                 return;
     355                 :            :         }
     356                 :            : 
     357         [ +  + ]:       4561 :         TAILQ_REMOVE(ring_list, te, next);
     358                 :            : 
     359                 :       4561 :         rte_mcfg_tailq_write_unlock();
     360                 :            : 
     361         [ -  + ]:       4561 :         if (rte_memzone_free(r->memzone) != 0)
     362                 :          0 :                 RING_LOG(ERR, "Cannot free memory");
     363                 :            : 
     364                 :       4561 :         rte_free(te);
     365                 :            : }
     366                 :            : 
     367                 :            : /* dump the status of the ring on the console */
     368                 :            : void
     369                 :          1 : rte_ring_dump(FILE *f, const struct rte_ring *r)
     370                 :            : {
     371                 :          1 :         fprintf(f, "ring <%s>@%p\n", r->name, r);
     372                 :          1 :         fprintf(f, "  flags=%x\n", r->flags);
     373                 :          1 :         fprintf(f, "  size=%"PRIu32"\n", r->size);
     374                 :          1 :         fprintf(f, "  capacity=%"PRIu32"\n", r->capacity);
     375                 :          1 :         fprintf(f, "  ct=%"PRIu32"\n", r->cons.tail);
     376                 :          1 :         fprintf(f, "  ch=%"PRIu32"\n", r->cons.head);
     377                 :          1 :         fprintf(f, "  pt=%"PRIu32"\n", r->prod.tail);
     378                 :          1 :         fprintf(f, "  ph=%"PRIu32"\n", r->prod.head);
     379                 :            :         fprintf(f, "  used=%u\n", rte_ring_count(r));
     380                 :            :         fprintf(f, "  avail=%u\n", rte_ring_free_count(r));
     381                 :          1 : }
     382                 :            : 
     383                 :            : /* dump the status of all rings on the console */
     384                 :            : void
     385                 :          1 : rte_ring_list_dump(FILE *f)
     386                 :            : {
     387                 :            :         const struct rte_tailq_entry *te;
     388                 :            :         struct rte_ring_list *ring_list;
     389                 :            : 
     390                 :          1 :         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
     391                 :            : 
     392                 :          1 :         rte_mcfg_tailq_read_lock();
     393                 :            : 
     394         [ -  + ]:          1 :         TAILQ_FOREACH(te, ring_list, next) {
     395                 :          0 :                 rte_ring_dump(f, (struct rte_ring *) te->data);
     396                 :            :         }
     397                 :            : 
     398                 :          1 :         rte_mcfg_tailq_read_unlock();
     399                 :          1 : }
     400                 :            : 
     401                 :            : /* search a ring from its name */
     402                 :            : struct rte_ring *
     403                 :       4041 : rte_ring_lookup(const char *name)
     404                 :            : {
     405                 :            :         struct rte_tailq_entry *te;
     406                 :            :         struct rte_ring *r = NULL;
     407                 :            :         struct rte_ring_list *ring_list;
     408                 :            : 
     409                 :       4041 :         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
     410                 :            : 
     411                 :       4041 :         rte_mcfg_tailq_read_lock();
     412                 :            : 
     413         [ +  + ]:      46836 :         TAILQ_FOREACH(te, ring_list, next) {
     414                 :      42980 :                 r = (struct rte_ring *) te->data;
     415         [ +  + ]:      42980 :                 if (strncmp(name, r->name, RTE_RING_NAMESIZE) == 0)
     416                 :            :                         break;
     417                 :            :         }
     418                 :            : 
     419                 :       4041 :         rte_mcfg_tailq_read_unlock();
     420                 :            : 
     421         [ +  + ]:       4041 :         if (te == NULL) {
     422                 :       3856 :                 rte_errno = ENOENT;
     423                 :       3856 :                 return NULL;
     424                 :            :         }
     425                 :            : 
     426                 :            :         return r;
     427                 :            : }
     428                 :            : 
     429                 :            : static void
     430                 :          0 : ring_walk(void (*func)(struct rte_ring *, void *), void *arg)
     431                 :            : {
     432                 :            :         struct rte_ring_list *ring_list;
     433                 :            :         struct rte_tailq_entry *tailq_entry;
     434                 :            : 
     435                 :          0 :         ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
     436                 :          0 :         rte_mcfg_tailq_read_lock();
     437                 :            : 
     438         [ #  # ]:          0 :         TAILQ_FOREACH(tailq_entry, ring_list, next) {
     439                 :          0 :                 (*func)((struct rte_ring *) tailq_entry->data, arg);
     440                 :            :         }
     441                 :            : 
     442                 :          0 :         rte_mcfg_tailq_read_unlock();
     443                 :          0 : }
     444                 :            : 
     445                 :            : static void
     446                 :          0 : ring_list_cb(struct rte_ring *r, void *arg)
     447                 :            : {
     448                 :            :         struct rte_tel_data *d = (struct rte_tel_data *)arg;
     449                 :            : 
     450                 :          0 :         rte_tel_data_add_array_string(d, r->name);
     451                 :          0 : }
     452                 :            : 
     453                 :            : static int
     454                 :          0 : ring_handle_list(const char *cmd __rte_unused,
     455                 :            :                 const char *params __rte_unused, struct rte_tel_data *d)
     456                 :            : {
     457                 :          0 :         rte_tel_data_start_array(d, RTE_TEL_STRING_VAL);
     458                 :          0 :         ring_walk(ring_list_cb, d);
     459                 :          0 :         return 0;
     460                 :            : }
     461                 :            : 
     462                 :            : static const char *
     463                 :            : ring_prod_sync_type_to_name(struct rte_ring *r)
     464                 :            : {
     465   [ #  #  #  #  :          0 :         switch (r->prod.sync_type) {
                      # ]
     466                 :            :         case RTE_RING_SYNC_MT:
     467                 :            :                 return "MP";
     468                 :          0 :         case RTE_RING_SYNC_ST:
     469                 :          0 :                 return "SP";
     470                 :          0 :         case RTE_RING_SYNC_MT_RTS:
     471                 :          0 :                 return "MP_RTS";
     472                 :          0 :         case RTE_RING_SYNC_MT_HTS:
     473                 :          0 :                 return "MP_HTS";
     474                 :          0 :         default:
     475                 :          0 :                 return "Unknown";
     476                 :            :         }
     477                 :            : }
     478                 :            : 
     479                 :            : static const char *
     480                 :            : ring_cons_sync_type_to_name(struct rte_ring *r)
     481                 :            : {
     482   [ #  #  #  #  :          0 :         switch (r->cons.sync_type) {
                      # ]
     483                 :            :         case RTE_RING_SYNC_MT:
     484                 :            :                 return "MC";
     485                 :          0 :         case RTE_RING_SYNC_ST:
     486                 :          0 :                 return "SC";
     487                 :          0 :         case RTE_RING_SYNC_MT_RTS:
     488                 :          0 :                 return "MC_RTS";
     489                 :          0 :         case RTE_RING_SYNC_MT_HTS:
     490                 :          0 :                 return "MC_HTS";
     491                 :          0 :         default:
     492                 :          0 :                 return "Unknown";
     493                 :            :         }
     494                 :            : }
     495                 :            : 
     496                 :            : struct ring_info_cb_arg {
     497                 :            :         char *ring_name;
     498                 :            :         struct rte_tel_data *d;
     499                 :            : };
     500                 :            : 
     501                 :            : static void
     502                 :          0 : ring_info_cb(struct rte_ring *r, void *arg)
     503                 :            : {
     504                 :            :         struct ring_info_cb_arg *ring_arg = (struct ring_info_cb_arg *)arg;
     505                 :          0 :         struct rte_tel_data *d = ring_arg->d;
     506                 :            :         const struct rte_memzone *mz;
     507                 :            : 
     508         [ #  # ]:          0 :         if (strncmp(r->name, ring_arg->ring_name, RTE_RING_NAMESIZE))
     509                 :            :                 return;
     510                 :            : 
     511                 :          0 :         rte_tel_data_add_dict_string(d, "name", r->name);
     512                 :          0 :         rte_tel_data_add_dict_int(d, "socket", r->memzone->socket_id);
     513                 :          0 :         rte_tel_data_add_dict_int(d, "flags", r->flags);
     514                 :          0 :         rte_tel_data_add_dict_string(d, "producer_type",
     515                 :            :                 ring_prod_sync_type_to_name(r));
     516                 :          0 :         rte_tel_data_add_dict_string(d, "consumer_type",
     517                 :            :                 ring_cons_sync_type_to_name(r));
     518                 :          0 :         rte_tel_data_add_dict_uint(d, "size", r->size);
     519                 :          0 :         rte_tel_data_add_dict_uint_hex(d, "mask", r->mask, 0);
     520                 :          0 :         rte_tel_data_add_dict_uint(d, "capacity", r->capacity);
     521                 :          0 :         rte_tel_data_add_dict_uint(d, "used_count", rte_ring_count(r));
     522                 :            : 
     523                 :          0 :         mz = r->memzone;
     524         [ #  # ]:          0 :         if (mz == NULL)
     525                 :            :                 return;
     526                 :          0 :         rte_tel_data_add_dict_string(d, "mz_name", mz->name);
     527                 :          0 :         rte_tel_data_add_dict_uint(d, "mz_len", mz->len);
     528                 :          0 :         rte_tel_data_add_dict_uint(d, "mz_hugepage_sz", mz->hugepage_sz);
     529                 :          0 :         rte_tel_data_add_dict_int(d, "mz_socket_id", mz->socket_id);
     530                 :          0 :         rte_tel_data_add_dict_uint_hex(d, "mz_flags", mz->flags, 0);
     531                 :            : }
     532                 :            : 
     533                 :            : static int
     534                 :          0 : ring_handle_info(const char *cmd __rte_unused, const char *params,
     535                 :            :                 struct rte_tel_data *d)
     536                 :            : {
     537                 :          0 :         char name[RTE_RING_NAMESIZE] = {0};
     538                 :            :         struct ring_info_cb_arg ring_arg;
     539                 :            : 
     540   [ #  #  #  # ]:          0 :         if (params == NULL || strlen(params) == 0 ||
     541         [ #  # ]:          0 :                 strlen(params) >= RTE_RING_NAMESIZE)
     542                 :            :                 return -EINVAL;
     543                 :            : 
     544                 :            :         rte_strlcpy(name, params, RTE_RING_NAMESIZE);
     545                 :            : 
     546                 :          0 :         ring_arg.ring_name = name;
     547                 :          0 :         ring_arg.d = d;
     548                 :            : 
     549                 :          0 :         rte_tel_data_start_dict(d);
     550                 :          0 :         ring_walk(ring_info_cb, &ring_arg);
     551                 :            : 
     552                 :          0 :         return 0;
     553                 :            : }
     554                 :            : 
     555                 :        251 : RTE_INIT(ring_init_telemetry)
     556                 :            : {
     557                 :        251 :         rte_telemetry_register_cmd("/ring/list", ring_handle_list,
     558                 :            :                 "Returns list of available rings. Takes no parameters");
     559                 :        251 :         rte_telemetry_register_cmd("/ring/info", ring_handle_info,
     560                 :            :                 "Returns ring info. Parameters: ring_name.");
     561                 :        251 : }

Generated by: LCOV version 1.14