lib/librte_fib/rte_fib.c

   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
   9 #include <rte_eal.h>
  10 #include <rte_eal_memconfig.h>
  11 #include <rte_errno.h>
  12 #include <rte_malloc.h>
  13 #include <rte_rwlock.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
  22 TAILQ_HEAD(rte_fib_list, rte_tailq_entry);
  23 static struct rte_tailq_elem rte_fib_tailq = {
  24         .name = "RTE_FIB",
  25 };
  26 EAL_REGISTER_TAILQ(rte_fib_tailq)
  27
  28 /* Maximum length of a FIB name. */
  29 #define RTE_FIB_NAMESIZE        64
  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         struct rte_rib          *rib;   /**< RIB helper datastruct */
  44         void                    *dp;    /**< pointer to the dataplane struct*/
  45         rte_fib_lookup_fn_t     lookup; /**< fib lookup function */
  46         rte_fib_modify_fn_t     modify; /**< modify fib datastruct */
  47         uint64_t                def_nh;
  48 };
  49
  50 static void
  51 dummy_lookup(void *fib_p, const uint32_t *ips, uint64_t *next_hops,
  52         const unsigned int n)
  53 {
  54         unsigned int i;
  55         struct rte_fib *fib = fib_p;
  56         struct rte_rib_node *node;
  57
  58         for (i = 0; i < n; i++) {
  59                 node = rte_rib_lookup(fib->rib, ips[i]);
  60                 if (node != NULL)
  61                         rte_rib_get_nh(node, &next_hops[i]);
  62                 else
  63                         next_hops[i] = fib->def_nh;
  64         }
  65 }
  66
  67 static int
  68 dummy_modify(struct rte_fib *fib, uint32_t ip, uint8_t depth,
  69         uint64_t next_hop, int op)
  70 {
  71         struct rte_rib_node *node;
  72         if ((fib == NULL) || (depth > RTE_FIB_MAXDEPTH))
  73                 return -EINVAL;
  74
  75         node = rte_rib_lookup_exact(fib->rib, ip, depth);
  76
  77         switch (op) {
  78         case RTE_FIB_ADD:
  79                 if (node == NULL)
  80                         node = rte_rib_insert(fib->rib, ip, depth);
  81                 if (node == NULL)
  82                         return -rte_errno;
  83                 return rte_rib_set_nh(node, next_hop);
  84         case RTE_FIB_DEL:
  85                 if (node == NULL)
  86                         return -ENOENT;
  87                 rte_rib_remove(fib->rib, ip, depth);
  88                 return 0;
  89         }
  90         return -EINVAL;
  91 }
  92
  93 static int
  94 init_dataplane(struct rte_fib *fib, __rte_unused int socket_id,
  95         struct rte_fib_conf *conf)
  96 {
  97         char dp_name[sizeof(void *)];
  98
  99         snprintf(dp_name, sizeof(dp_name), "%p", fib);
 100         switch (conf->type) {
 101         case RTE_FIB_DUMMY:
 102                 fib->dp = fib;
 103                 fib->lookup = dummy_lookup;
 104                 fib->modify = dummy_modify;
 105                 return 0;
 106         case RTE_FIB_DIR24_8:
 107                 fib->dp = dir24_8_create(dp_name, socket_id, conf);
 108                 if (fib->dp == NULL)
 109                         return -rte_errno;
 110                 fib->lookup = dir24_8_get_lookup_fn(conf);
 111                 fib->modify = dir24_8_modify;
 112                 return 0;
 113         default:
 114                 return -EINVAL;
 115         }
 116         return 0;
 117 }
 118
 119 int
 120 rte_fib_add(struct rte_fib *fib, uint32_t ip, uint8_t depth, uint64_t next_hop)
 121 {
 122         if ((fib == NULL) || (fib->modify == NULL) ||
 123                         (depth > RTE_FIB_MAXDEPTH))
 124                 return -EINVAL;
 125         return fib->modify(fib, ip, depth, next_hop, RTE_FIB_ADD);
 126 }
 127
 128 int
 129 rte_fib_delete(struct rte_fib *fib, uint32_t ip, uint8_t depth)
 130 {
 131         if ((fib == NULL) || (fib->modify == NULL) ||
 132                         (depth > RTE_FIB_MAXDEPTH))
 133                 return -EINVAL;
 134         return fib->modify(fib, ip, depth, 0, RTE_FIB_DEL);
 135 }
 136
 137 int
 138 rte_fib_lookup_bulk(struct rte_fib *fib, uint32_t *ips,
 139         uint64_t *next_hops, int n)
 140 {
 141         FIB_RETURN_IF_TRUE(((fib == NULL) || (ips == NULL) ||
 142                 (next_hops == NULL) || (fib->lookup == NULL)), -EINVAL);
 143
 144         fib->lookup(fib->dp, ips, next_hops, n);
 145         return 0;
 146 }
 147
 148 struct rte_fib *
 149 rte_fib_create(const char *name, int socket_id, struct rte_fib_conf *conf)
 150 {
 151         char mem_name[RTE_FIB_NAMESIZE];
 152         int ret;
 153         struct rte_fib *fib = NULL;
 154         struct rte_rib *rib = NULL;
 155         struct rte_tailq_entry *te;
 156         struct rte_fib_list *fib_list;
 157         struct rte_rib_conf rib_conf;
 158
 159         /* Check user arguments. */
 160         if ((name == NULL) || (conf == NULL) || (conf->max_routes < 0) ||
 161                         (conf->type >= RTE_FIB_TYPE_MAX)) {
 162                 rte_errno = EINVAL;
 163                 return NULL;
 164         }
 165
 166         rib_conf.ext_sz = 0;
 167         rib_conf.max_nodes = conf->max_routes * 2;
 168
 169         rib = rte_rib_create(name, socket_id, &rib_conf);
 170         if (rib == NULL) {
 171                 RTE_LOG(ERR, LPM,
 172                         "Can not allocate RIB %s\n", name);
 173                 return NULL;
 174         }
 175
 176         snprintf(mem_name, sizeof(mem_name), "FIB_%s", name);
 177         fib_list = RTE_TAILQ_CAST(rte_fib_tailq.head, rte_fib_list);
 178
 179         rte_mcfg_tailq_write_lock();
 180
 181         /* guarantee there's no existing */
 182         TAILQ_FOREACH(te, fib_list, next) {
 183                 fib = (struct rte_fib *)te->data;
 184                 if (strncmp(name, fib->name, RTE_FIB_NAMESIZE) == 0)
 185                         break;
 186         }
 187         fib = NULL;
 188         if (te != NULL) {
 189                 rte_errno = EEXIST;
 190                 goto exit;
 191         }
 192
 193         /* allocate tailq entry */
 194         te = rte_zmalloc("FIB_TAILQ_ENTRY", sizeof(*te), 0);
 195         if (te == NULL) {
 196                 RTE_LOG(ERR, LPM,
 197                         "Can not allocate tailq entry for FIB %s\n", name);
 198                 rte_errno = ENOMEM;
 199                 goto exit;
 200         }
 201
 202         /* Allocate memory to store the FIB data structures. */
 203         fib = rte_zmalloc_socket(mem_name,
 204                 sizeof(struct rte_fib), RTE_CACHE_LINE_SIZE, socket_id);
 205         if (fib == NULL) {
 206                 RTE_LOG(ERR, LPM, "FIB %s memory allocation failed\n", name);
 207                 rte_errno = ENOMEM;
 208                 goto free_te;
 209         }
 210
 211         rte_strlcpy(fib->name, name, sizeof(fib->name));
 212         fib->rib = rib;
 213         fib->type = conf->type;
 214         fib->def_nh = conf->default_nh;
 215         ret = init_dataplane(fib, socket_id, conf);
 216         if (ret < 0) {
 217                 RTE_LOG(ERR, LPM,
 218                         "FIB dataplane struct %s memory allocation failed "
 219                         "with err %d\n", name, ret);
 220                 rte_errno = -ret;
 221                 goto free_fib;
 222         }
 223
 224         te->data = (void *)fib;
 225         TAILQ_INSERT_TAIL(fib_list, te, next);
 226
 227         rte_mcfg_tailq_write_unlock();
 228
 229         return fib;
 230
 231 free_fib:
 232         rte_free(fib);
 233 free_te:
 234         rte_free(te);
 235 exit:
 236         rte_mcfg_tailq_write_unlock();
 237         rte_rib_free(rib);
 238
 239         return NULL;
 240 }
 241
 242 struct rte_fib *
 243 rte_fib_find_existing(const char *name)
 244 {
 245         struct rte_fib *fib = NULL;
 246         struct rte_tailq_entry *te;
 247         struct rte_fib_list *fib_list;
 248
 249         fib_list = RTE_TAILQ_CAST(rte_fib_tailq.head, rte_fib_list);
 250
 251         rte_mcfg_tailq_read_lock();
 252         TAILQ_FOREACH(te, fib_list, next) {
 253                 fib = (struct rte_fib *) te->data;
 254                 if (strncmp(name, fib->name, RTE_FIB_NAMESIZE) == 0)
 255                         break;
 256         }
 257         rte_mcfg_tailq_read_unlock();
 258
 259         if (te == NULL) {
 260                 rte_errno = ENOENT;
 261                 return NULL;
 262         }
 263
 264         return fib;
 265 }
 266
 267 static void
 268 free_dataplane(struct rte_fib *fib)
 269 {
 270         switch (fib->type) {
 271         case RTE_FIB_DUMMY:
 272                 return;
 273         case RTE_FIB_DIR24_8:
 274                 dir24_8_free(fib->dp);
 275         default:
 276                 return;
 277         }
 278 }
 279
 280 void
 281 rte_fib_free(struct rte_fib *fib)
 282 {
 283         struct rte_tailq_entry *te;
 284         struct rte_fib_list *fib_list;
 285
 286         if (fib == NULL)
 287                 return;
 288
 289         fib_list = RTE_TAILQ_CAST(rte_fib_tailq.head, rte_fib_list);
 290
 291         rte_mcfg_tailq_write_lock();
 292
 293         /* find our tailq entry */
 294         TAILQ_FOREACH(te, fib_list, next) {
 295                 if (te->data == (void *)fib)
 296                         break;
 297         }
 298         if (te != NULL)
 299                 TAILQ_REMOVE(fib_list, te, next);
 300
 301         rte_mcfg_tailq_write_unlock();
 302
 303         free_dataplane(fib);
 304         rte_rib_free(fib->rib);
 305         rte_free(fib);
 306         rte_free(te);
 307 }
 308
 309 void *
 310 rte_fib_get_dp(struct rte_fib *fib)
 311 {
 312         return (fib == NULL) ? NULL : fib->dp;
 313 }
 314
 315 struct rte_rib *
 316 rte_fib_get_rib(struct rte_fib *fib)
 317 {
 318         return (fib == NULL) ? NULL : fib->rib;
 319 }