LCOV - code coverage report
Current view: top level - lib/fib - rte_fib.c (source / functions) Hit Total Coverage
Test: Code coverage Lines: 111 140 79.3 %
Date: 2025-08-01 17:49:26 Functions: 13 15 86.7 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 58 91 63.7 %

           Branch data     Line data    Source code
       1                 :            : /* SPDX-License-Identifier: BSD-3-Clause
       2                 :            :  * Copyright(c) 2018 Vladimir Medvedkin <medvedkinv@gmail.com>
       3                 :            :  * Copyright(c) 2019 Intel Corporation
       4                 :            :  */
       5                 :            : 
       6                 :            : #include <stdint.h>
       7                 :            : #include <string.h>
       8                 :            : #include <sys/queue.h>
       9                 :            : 
      10                 :            : #include <eal_export.h>
      11                 :            : #include <rte_eal_memconfig.h>
      12                 :            : #include <rte_errno.h>
      13                 :            : #include <rte_malloc.h>
      14                 :            : #include <rte_string_fns.h>
      15                 :            : #include <rte_tailq.h>
      16                 :            : 
      17                 :            : #include <rte_rib.h>
      18                 :            : #include <rte_fib.h>
      19                 :            : 
      20                 :            : #include "dir24_8.h"
      21                 :            : #include "fib_log.h"
      22                 :            : 
      23         [ -  + ]:        253 : RTE_LOG_REGISTER_DEFAULT(fib_logtype, INFO);
      24                 :            : 
      25                 :            : TAILQ_HEAD(rte_fib_list, rte_tailq_entry);
      26                 :            : static struct rte_tailq_elem rte_fib_tailq = {
      27                 :            :         .name = "RTE_FIB",
      28                 :            : };
      29         [ -  + ]:        253 : EAL_REGISTER_TAILQ(rte_fib_tailq)
      30                 :            : 
      31                 :            : #if defined(RTE_LIBRTE_FIB_DEBUG)
      32                 :            : #define FIB_RETURN_IF_TRUE(cond, retval) do {           \
      33                 :            :         if (cond)                                       \
      34                 :            :                 return retval;                          \
      35                 :            : } while (0)
      36                 :            : #else
      37                 :            : #define FIB_RETURN_IF_TRUE(cond, retval)
      38                 :            : #endif
      39                 :            : 
      40                 :            : struct rte_fib {
      41                 :            :         char                    name[RTE_FIB_NAMESIZE];
      42                 :            :         enum rte_fib_type       type;   /**< Type of FIB struct */
      43                 :            :         unsigned int flags;             /**< Flags */
      44                 :            :         struct rte_rib          *rib;   /**< RIB helper datastructure */
      45                 :            :         void                    *dp;    /**< pointer to the dataplane struct*/
      46                 :            :         rte_fib_lookup_fn_t     lookup; /**< FIB lookup function */
      47                 :            :         rte_fib_modify_fn_t     modify; /**< modify FIB datastructure */
      48                 :            :         uint64_t                def_nh;
      49                 :            : };
      50                 :            : 
      51                 :            : static void
      52                 :        258 : dummy_lookup(void *fib_p, const uint32_t *ips, uint64_t *next_hops,
      53                 :            :         const unsigned int n)
      54                 :            : {
      55                 :            :         unsigned int i;
      56                 :            :         struct rte_fib *fib = fib_p;
      57                 :            :         struct rte_rib_node *node;
      58                 :            : 
      59         [ +  + ]:       4515 :         for (i = 0; i < n; i++) {
      60                 :       4257 :                 node = rte_rib_lookup(fib->rib, ips[i]);
      61         [ +  + ]:       4257 :                 if (node != NULL)
      62                 :       3040 :                         rte_rib_get_nh(node, &next_hops[i]);
      63                 :            :                 else
      64                 :       1217 :                         next_hops[i] = fib->def_nh;
      65                 :            :         }
      66                 :        258 : }
      67                 :            : 
      68                 :            : static int
      69                 :        128 : dummy_modify(struct rte_fib *fib, uint32_t ip, uint8_t depth,
      70                 :            :         uint64_t next_hop, int op)
      71                 :            : {
      72                 :            :         struct rte_rib_node *node;
      73         [ +  - ]:        128 :         if ((fib == NULL) || (depth > RTE_FIB_MAXDEPTH))
      74                 :            :                 return -EINVAL;
      75                 :            : 
      76                 :        128 :         node = rte_rib_lookup_exact(fib->rib, ip, depth);
      77                 :            : 
      78      [ +  +  - ]:        128 :         switch (op) {
      79                 :         64 :         case RTE_FIB_ADD:
      80         [ +  - ]:         64 :                 if (node == NULL)
      81                 :         64 :                         node = rte_rib_insert(fib->rib, ip, depth);
      82         [ -  + ]:         64 :                 if (node == NULL)
      83                 :          0 :                         return -rte_errno;
      84                 :         64 :                 return rte_rib_set_nh(node, next_hop);
      85                 :         64 :         case RTE_FIB_DEL:
      86         [ +  - ]:         64 :                 if (node == NULL)
      87                 :            :                         return -ENOENT;
      88                 :         64 :                 rte_rib_remove(fib->rib, ip, depth);
      89                 :         64 :                 return 0;
      90                 :            :         }
      91                 :            :         return -EINVAL;
      92                 :            : }
      93                 :            : 
      94                 :            : static int
      95      [ +  +  - ]:         12 : init_dataplane(struct rte_fib *fib, __rte_unused int socket_id,
      96                 :            :         struct rte_fib_conf *conf)
      97                 :            : {
      98                 :            :         char dp_name[sizeof(void *)];
      99                 :            : 
     100                 :            :         snprintf(dp_name, sizeof(dp_name), "%p", fib);
     101      [ +  +  - ]:         12 :         switch (conf->type) {
     102                 :          4 :         case RTE_FIB_DUMMY:
     103                 :          4 :                 fib->dp = fib;
     104                 :          4 :                 fib->lookup = dummy_lookup;
     105                 :          4 :                 fib->modify = dummy_modify;
     106                 :          4 :                 return 0;
     107                 :          8 :         case RTE_FIB_DIR24_8:
     108                 :          8 :                 fib->dp = dir24_8_create(dp_name, socket_id, conf);
     109         [ +  + ]:          8 :                 if (fib->dp == NULL)
     110                 :          2 :                         return -rte_errno;
     111                 :         12 :                 fib->lookup = dir24_8_get_lookup_fn(fib->dp,
     112                 :          6 :                         RTE_FIB_LOOKUP_DEFAULT, !!(fib->flags & RTE_FIB_F_LOOKUP_NETWORK_ORDER));
     113                 :          6 :                 fib->modify = dir24_8_modify;
     114                 :          6 :                 return 0;
     115                 :            :         default:
     116                 :            :                 return -EINVAL;
     117                 :            :         }
     118                 :            :         return 0;
     119                 :            : }
     120                 :            : 
     121                 :            : RTE_EXPORT_SYMBOL(rte_fib_add)
     122                 :            : int
     123                 :        835 : rte_fib_add(struct rte_fib *fib, uint32_t ip, uint8_t depth, uint64_t next_hop)
     124                 :            : {
     125   [ +  +  +  -  :        835 :         if ((fib == NULL) || (fib->modify == NULL) ||
                   +  + ]
     126                 :            :                         (depth > RTE_FIB_MAXDEPTH))
     127                 :            :                 return -EINVAL;
     128                 :        833 :         return fib->modify(fib, ip, depth, next_hop, RTE_FIB_ADD);
     129                 :            : }
     130                 :            : 
     131                 :            : RTE_EXPORT_SYMBOL(rte_fib_delete)
     132                 :            : int
     133                 :        834 : rte_fib_delete(struct rte_fib *fib, uint32_t ip, uint8_t depth)
     134                 :            : {
     135   [ +  +  +  -  :        834 :         if ((fib == NULL) || (fib->modify == NULL) ||
                   +  + ]
     136                 :            :                         (depth > RTE_FIB_MAXDEPTH))
     137                 :            :                 return -EINVAL;
     138                 :        832 :         return fib->modify(fib, ip, depth, 0, RTE_FIB_DEL);
     139                 :            : }
     140                 :            : 
     141                 :            : RTE_EXPORT_SYMBOL(rte_fib_lookup_bulk)
     142                 :            : int
     143                 :     528650 : rte_fib_lookup_bulk(struct rte_fib *fib, uint32_t *ips,
     144                 :            :         uint64_t *next_hops, int n)
     145                 :            : {
     146                 :            :         FIB_RETURN_IF_TRUE(((fib == NULL) || (ips == NULL) ||
     147                 :            :                 (next_hops == NULL) || (fib->lookup == NULL)), -EINVAL);
     148                 :            : 
     149                 :     528650 :         fib->lookup(fib->dp, ips, next_hops, n);
     150                 :     528650 :         return 0;
     151                 :            : }
     152                 :            : 
     153                 :            : RTE_EXPORT_SYMBOL(rte_fib_create)
     154                 :            : struct rte_fib *
     155                 :         17 : rte_fib_create(const char *name, int socket_id, struct rte_fib_conf *conf)
     156                 :            : {
     157                 :            :         char mem_name[RTE_FIB_NAMESIZE];
     158                 :            :         int ret;
     159                 :            :         struct rte_fib *fib = NULL;
     160                 :            :         struct rte_rib *rib = NULL;
     161                 :            :         struct rte_tailq_entry *te;
     162                 :            :         struct rte_fib_list *fib_list;
     163                 :            :         struct rte_rib_conf rib_conf;
     164                 :            : 
     165                 :            :         /* Check user arguments. */
     166   [ +  +  +  - ]:         17 :         if ((name == NULL) || (conf == NULL) || (conf->max_routes < 0) ||
     167         [ +  - ]:         15 :                         (conf->flags & ~RTE_FIB_ALLOWED_FLAGS) ||
     168         [ +  + ]:         15 :                         (conf->type > RTE_FIB_DIR24_8)) {
     169                 :          3 :                 rte_errno = EINVAL;
     170                 :          3 :                 return NULL;
     171                 :            :         }
     172                 :            : 
     173                 :         14 :         rib_conf.ext_sz = conf->rib_ext_sz;
     174                 :         14 :         rib_conf.max_nodes = conf->max_routes * 2;
     175                 :            : 
     176                 :         14 :         rib = rte_rib_create(name, socket_id, &rib_conf);
     177         [ +  + ]:         14 :         if (rib == NULL) {
     178                 :          2 :                 FIB_LOG(ERR,
     179                 :            :                         "Can not allocate RIB %s", name);
     180                 :          2 :                 return NULL;
     181                 :            :         }
     182                 :            : 
     183                 :            :         snprintf(mem_name, sizeof(mem_name), "FIB_%s", name);
     184                 :         12 :         fib_list = RTE_TAILQ_CAST(rte_fib_tailq.head, rte_fib_list);
     185                 :            : 
     186                 :         12 :         rte_mcfg_tailq_write_lock();
     187                 :            : 
     188                 :            :         /* guarantee there's no existing */
     189         [ -  + ]:         12 :         TAILQ_FOREACH(te, fib_list, next) {
     190                 :          0 :                 fib = (struct rte_fib *)te->data;
     191         [ #  # ]:          0 :                 if (strncmp(name, fib->name, RTE_FIB_NAMESIZE) == 0)
     192                 :            :                         break;
     193                 :            :         }
     194                 :            :         fib = NULL;
     195         [ -  + ]:         12 :         if (te != NULL) {
     196                 :          0 :                 rte_errno = EEXIST;
     197                 :          0 :                 goto exit;
     198                 :            :         }
     199                 :            : 
     200                 :            :         /* allocate tailq entry */
     201                 :         12 :         te = rte_zmalloc("FIB_TAILQ_ENTRY", sizeof(*te), 0);
     202         [ -  + ]:         12 :         if (te == NULL) {
     203                 :          0 :                 FIB_LOG(ERR,
     204                 :            :                         "Can not allocate tailq entry for FIB %s", name);
     205                 :          0 :                 rte_errno = ENOMEM;
     206                 :          0 :                 goto exit;
     207                 :            :         }
     208                 :            : 
     209                 :            :         /* Allocate memory to store the FIB data structures. */
     210                 :         12 :         fib = rte_zmalloc_socket(mem_name,
     211                 :            :                 sizeof(struct rte_fib), RTE_CACHE_LINE_SIZE, socket_id);
     212         [ -  + ]:         12 :         if (fib == NULL) {
     213                 :          0 :                 FIB_LOG(ERR, "FIB %s memory allocation failed", name);
     214                 :          0 :                 rte_errno = ENOMEM;
     215                 :          0 :                 goto free_te;
     216                 :            :         }
     217                 :            : 
     218                 :         12 :         rte_strlcpy(fib->name, name, sizeof(fib->name));
     219                 :         12 :         fib->rib = rib;
     220                 :         12 :         fib->type = conf->type;
     221                 :         12 :         fib->flags = conf->flags;
     222                 :         12 :         fib->def_nh = conf->default_nh;
     223                 :         12 :         ret = init_dataplane(fib, socket_id, conf);
     224         [ +  + ]:         12 :         if (ret < 0) {
     225                 :          2 :                 FIB_LOG(ERR,
     226                 :            :                         "FIB dataplane struct %s memory allocation failed "
     227                 :            :                         "with err %d", name, ret);
     228                 :          2 :                 rte_errno = -ret;
     229                 :          2 :                 goto free_fib;
     230                 :            :         }
     231                 :            : 
     232                 :         10 :         te->data = (void *)fib;
     233                 :         10 :         TAILQ_INSERT_TAIL(fib_list, te, next);
     234                 :            : 
     235                 :         10 :         rte_mcfg_tailq_write_unlock();
     236                 :            : 
     237                 :         10 :         return fib;
     238                 :            : 
     239                 :            : free_fib:
     240                 :          2 :         rte_free(fib);
     241                 :          2 : free_te:
     242                 :          2 :         rte_free(te);
     243                 :          2 : exit:
     244                 :          2 :         rte_mcfg_tailq_write_unlock();
     245                 :          2 :         rte_rib_free(rib);
     246                 :            : 
     247                 :          2 :         return NULL;
     248                 :            : }
     249                 :            : 
     250                 :            : RTE_EXPORT_SYMBOL(rte_fib_find_existing)
     251                 :            : struct rte_fib *
     252                 :          0 : rte_fib_find_existing(const char *name)
     253                 :            : {
     254                 :            :         struct rte_fib *fib = NULL;
     255                 :            :         struct rte_tailq_entry *te;
     256                 :            :         struct rte_fib_list *fib_list;
     257                 :            : 
     258                 :          0 :         fib_list = RTE_TAILQ_CAST(rte_fib_tailq.head, rte_fib_list);
     259                 :            : 
     260                 :          0 :         rte_mcfg_tailq_read_lock();
     261         [ #  # ]:          0 :         TAILQ_FOREACH(te, fib_list, next) {
     262                 :          0 :                 fib = (struct rte_fib *) te->data;
     263         [ #  # ]:          0 :                 if (strncmp(name, fib->name, RTE_FIB_NAMESIZE) == 0)
     264                 :            :                         break;
     265                 :            :         }
     266                 :          0 :         rte_mcfg_tailq_read_unlock();
     267                 :            : 
     268         [ #  # ]:          0 :         if (te == NULL) {
     269                 :          0 :                 rte_errno = ENOENT;
     270                 :          0 :                 return NULL;
     271                 :            :         }
     272                 :            : 
     273                 :            :         return fib;
     274                 :            : }
     275                 :            : 
     276                 :            : static void
     277                 :            : free_dataplane(struct rte_fib *fib)
     278                 :            : {
     279         [ +  + ]:         10 :         switch (fib->type) {
     280                 :            :         case RTE_FIB_DUMMY:
     281                 :            :                 return;
     282                 :          6 :         case RTE_FIB_DIR24_8:
     283                 :          6 :                 dir24_8_free(fib->dp);
     284                 :            :         default:
     285                 :            :                 return;
     286                 :            :         }
     287                 :            : }
     288                 :            : 
     289                 :            : RTE_EXPORT_SYMBOL(rte_fib_free)
     290                 :            : void
     291                 :         11 : rte_fib_free(struct rte_fib *fib)
     292                 :            : {
     293                 :            :         struct rte_tailq_entry *te;
     294                 :            :         struct rte_fib_list *fib_list;
     295                 :            : 
     296         [ +  + ]:         11 :         if (fib == NULL)
     297                 :            :                 return;
     298                 :            : 
     299                 :         10 :         fib_list = RTE_TAILQ_CAST(rte_fib_tailq.head, rte_fib_list);
     300                 :            : 
     301                 :         10 :         rte_mcfg_tailq_write_lock();
     302                 :            : 
     303                 :            :         /* find our tailq entry */
     304         [ +  - ]:         10 :         TAILQ_FOREACH(te, fib_list, next) {
     305         [ -  + ]:         10 :                 if (te->data == (void *)fib)
     306                 :            :                         break;
     307                 :            :         }
     308         [ +  - ]:         10 :         if (te != NULL)
     309         [ -  + ]:         10 :                 TAILQ_REMOVE(fib_list, te, next);
     310                 :            : 
     311                 :         10 :         rte_mcfg_tailq_write_unlock();
     312                 :            : 
     313                 :            :         free_dataplane(fib);
     314                 :         10 :         rte_rib_free(fib->rib);
     315                 :         10 :         rte_free(fib);
     316                 :         10 :         rte_free(te);
     317                 :            : }
     318                 :            : 
     319                 :            : RTE_EXPORT_SYMBOL(rte_fib_get_dp)
     320                 :            : void *
     321                 :       1538 : rte_fib_get_dp(struct rte_fib *fib)
     322                 :            : {
     323         [ +  + ]:       1538 :         return (fib == NULL) ? NULL : fib->dp;
     324                 :            : }
     325                 :            : 
     326                 :            : RTE_EXPORT_SYMBOL(rte_fib_get_rib)
     327                 :            : struct rte_rib *
     328                 :       1538 : rte_fib_get_rib(struct rte_fib *fib)
     329                 :            : {
     330         [ +  + ]:       1538 :         return (fib == NULL) ? NULL : fib->rib;
     331                 :            : }
     332                 :            : 
     333                 :            : RTE_EXPORT_SYMBOL(rte_fib_select_lookup)
     334                 :            : int
     335                 :          0 : rte_fib_select_lookup(struct rte_fib *fib,
     336                 :            :         enum rte_fib_lookup_type type)
     337                 :            : {
     338                 :            :         rte_fib_lookup_fn_t fn;
     339                 :            : 
     340         [ #  # ]:          0 :         switch (fib->type) {
     341                 :          0 :         case RTE_FIB_DIR24_8:
     342                 :          0 :                 fn = dir24_8_get_lookup_fn(fib->dp, type,
     343                 :          0 :                         !!(fib->flags & RTE_FIB_F_LOOKUP_NETWORK_ORDER));
     344         [ #  # ]:          0 :                 if (fn == NULL)
     345                 :            :                         return -EINVAL;
     346                 :          0 :                 fib->lookup = fn;
     347                 :          0 :                 return 0;
     348                 :            :         default:
     349                 :            :                 return -EINVAL;
     350                 :            :         }
     351                 :            : }
     352                 :            : 
     353                 :            : RTE_EXPORT_EXPERIMENTAL_SYMBOL(rte_fib_rcu_qsbr_add, 24.11)
     354                 :            : int
     355                 :          7 : rte_fib_rcu_qsbr_add(struct rte_fib *fib, struct rte_fib_rcu_config *cfg)
     356                 :            : {
     357         [ +  + ]:          7 :         if (fib == NULL)
     358                 :            :                 return -EINVAL;
     359                 :            : 
     360         [ +  + ]:          6 :         switch (fib->type) {
     361                 :          5 :         case RTE_FIB_DIR24_8:
     362                 :          5 :                 return dir24_8_rcu_qsbr_add(fib->dp, cfg, fib->name);
     363                 :            :         default:
     364                 :            :                 return -ENOTSUP;
     365                 :            :         }
     366                 :            : }

Generated by: LCOV version 1.14