lib/librte_table/rte_table_lpm.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #include <string.h>
  35 #include <stdio.h>
  36
  37 #include <rte_common.h>
  38 #include <rte_mbuf.h>
  39 #include <rte_memory.h>
  40 #include <rte_malloc.h>
  41 #include <rte_byteorder.h>
  42 #include <rte_log.h>
  43 #include <rte_lpm.h>
  44
  45 #include "rte_table_lpm.h"
  46
  47 #define RTE_TABLE_LPM_MAX_NEXT_HOPS                        256
  48
  49 #ifdef RTE_TABLE_STATS_COLLECT
  50
  51 #define RTE_TABLE_LPM_STATS_PKTS_IN_ADD(table, val) \
  52         table->stats.n_pkts_in += val
  53 #define RTE_TABLE_LPM_STATS_PKTS_LOOKUP_MISS(table, val) \
  54         table->stats.n_pkts_lookup_miss += val
  55
  56 #else
  57
  58 #define RTE_TABLE_LPM_STATS_PKTS_IN_ADD(table, val)
  59 #define RTE_TABLE_LPM_STATS_PKTS_LOOKUP_MISS(table, val)
  60
  61 #endif
  62
  63 struct rte_table_lpm {
  64         struct rte_table_stats stats;
  65
  66         /* Input parameters */
  67         uint32_t entry_size;
  68         uint32_t entry_unique_size;
  69         uint32_t n_rules;
  70         uint32_t offset;
  71
  72         /* Handle to low-level LPM table */
  73         struct rte_lpm *lpm;
  74
  75         /* Next Hop Table (NHT) */
  76         uint32_t nht_users[RTE_TABLE_LPM_MAX_NEXT_HOPS];
  77         uint32_t nht[0] __rte_cache_aligned;
  78 };
  79
  80 static void *
  81 rte_table_lpm_create(void *params, int socket_id, uint32_t entry_size)
  82 {
  83         struct rte_table_lpm_params *p = (struct rte_table_lpm_params *) params;
  84         struct rte_table_lpm *lpm;
  85         struct rte_lpm_config lpm_config;
  86
  87         uint32_t total_size, nht_size;
  88
  89         /* Check input parameters */
  90         if (p == NULL) {
  91                 RTE_LOG(ERR, TABLE, "%s: NULL input parameters\n", __func__);
  92                 return NULL;
  93         }
  94         if (p->n_rules == 0) {
  95                 RTE_LOG(ERR, TABLE, "%s: Invalid n_rules\n", __func__);
  96                 return NULL;
  97         }
  98         if (p->number_tbl8s == 0) {
  99                 RTE_LOG(ERR, TABLE, "%s: Invalid number_tbl8s\n", __func__);
 100                 return NULL;
 101         }
 102         if (p->entry_unique_size == 0) {
 103                 RTE_LOG(ERR, TABLE, "%s: Invalid entry_unique_size\n",
 104                         __func__);
 105                 return NULL;
 106         }
 107         if (p->entry_unique_size > entry_size) {
 108                 RTE_LOG(ERR, TABLE, "%s: Invalid entry_unique_size\n",
 109                         __func__);
 110                 return NULL;
 111         }
 112         if (p->name == NULL) {
 113                 RTE_LOG(ERR, TABLE, "%s: Table name is NULL\n",
 114                         __func__);
 115                 return NULL;
 116         }
 117         entry_size = RTE_ALIGN(entry_size, sizeof(uint64_t));
 118
 119         /* Memory allocation */
 120         nht_size = RTE_TABLE_LPM_MAX_NEXT_HOPS * entry_size;
 121         total_size = sizeof(struct rte_table_lpm) + nht_size;
 122         lpm = rte_zmalloc_socket("TABLE", total_size, RTE_CACHE_LINE_SIZE,
 123                 socket_id);
 124         if (lpm == NULL) {
 125                 RTE_LOG(ERR, TABLE,
 126                         "%s: Cannot allocate %u bytes for LPM table\n",
 127                         __func__, total_size);
 128                 return NULL;
 129         }
 130
 131         /* LPM low-level table creation */
 132         lpm_config.max_rules = p->n_rules;
 133         lpm_config.number_tbl8s = p->number_tbl8s;
 134         lpm_config.flags = p->flags;
 135         lpm->lpm = rte_lpm_create(p->name, socket_id, &lpm_config);
 136
 137         if (lpm->lpm == NULL) {
 138                 rte_free(lpm);
 139                 RTE_LOG(ERR, TABLE, "Unable to create low-level LPM table\n");
 140                 return NULL;
 141         }
 142
 143         /* Memory initialization */
 144         lpm->entry_size = entry_size;
 145         lpm->entry_unique_size = p->entry_unique_size;
 146         lpm->n_rules = p->n_rules;
 147         lpm->offset = p->offset;
 148
 149         return lpm;
 150 }
 151
 152 static int
 153 rte_table_lpm_free(void *table)
 154 {
 155         struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
 156
 157         /* Check input parameters */
 158         if (lpm == NULL) {
 159                 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
 160                 return -EINVAL;
 161         }
 162
 163         /* Free previously allocated resources */
 164         rte_lpm_free(lpm->lpm);
 165         rte_free(lpm);
 166
 167         return 0;
 168 }
 169
 170 static int
 171 nht_find_free(struct rte_table_lpm *lpm, uint32_t *pos)
 172 {
 173         uint32_t i;
 174
 175         for (i = 0; i < RTE_TABLE_LPM_MAX_NEXT_HOPS; i++) {
 176                 if (lpm->nht_users[i] == 0) {
 177                         *pos = i;
 178                         return 1;
 179                 }
 180         }
 181
 182         return 0;
 183 }
 184
 185 static int
 186 nht_find_existing(struct rte_table_lpm *lpm, void *entry, uint32_t *pos)
 187 {
 188         uint32_t i;
 189
 190         for (i = 0; i < RTE_TABLE_LPM_MAX_NEXT_HOPS; i++) {
 191                 uint32_t *nht_entry = &lpm->nht[i * lpm->entry_size];
 192
 193                 if ((lpm->nht_users[i] > 0) && (memcmp(nht_entry, entry,
 194                         lpm->entry_unique_size) == 0)) {
 195                         *pos = i;
 196                         return 1;
 197                 }
 198         }
 199
 200         return 0;
 201 }
 202
 203 static int
 204 rte_table_lpm_entry_add(
 205         void *table,
 206         void *key,
 207         void *entry,
 208         int *key_found,
 209         void **entry_ptr)
 210 {
 211         struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
 212         struct rte_table_lpm_key *ip_prefix = (struct rte_table_lpm_key *) key;
 213         uint32_t nht_pos, nht_pos0_valid;
 214         int status;
 215         uint32_t nht_pos0 = 0;
 216
 217         /* Check input parameters */
 218         if (lpm == NULL) {
 219                 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
 220                 return -EINVAL;
 221         }
 222         if (ip_prefix == NULL) {
 223                 RTE_LOG(ERR, TABLE, "%s: ip_prefix parameter is NULL\n",
 224                         __func__);
 225                 return -EINVAL;
 226         }
 227         if (entry == NULL) {
 228                 RTE_LOG(ERR, TABLE, "%s: entry parameter is NULL\n", __func__);
 229                 return -EINVAL;
 230         }
 231
 232         if ((ip_prefix->depth == 0) || (ip_prefix->depth > 32)) {
 233                 RTE_LOG(ERR, TABLE, "%s: invalid depth (%d)\n",
 234                         __func__, ip_prefix->depth);
 235                 return -EINVAL;
 236         }
 237
 238         /* Check if rule is already present in the table */
 239         status = rte_lpm_is_rule_present(lpm->lpm, ip_prefix->ip,
 240                 ip_prefix->depth, &nht_pos0);
 241         nht_pos0_valid = status > 0;
 242
 243         /* Find existing or free NHT entry */
 244         if (nht_find_existing(lpm, entry, &nht_pos) == 0) {
 245                 uint32_t *nht_entry;
 246
 247                 if (nht_find_free(lpm, &nht_pos) == 0) {
 248                         RTE_LOG(ERR, TABLE, "%s: NHT full\n", __func__);
 249                         return -1;
 250                 }
 251
 252                 nht_entry = &lpm->nht[nht_pos * lpm->entry_size];
 253                 memcpy(nht_entry, entry, lpm->entry_size);
 254         }
 255
 256         /* Add rule to low level LPM table */
 257         if (rte_lpm_add(lpm->lpm, ip_prefix->ip, ip_prefix->depth, nht_pos) < 0) {
 258                 RTE_LOG(ERR, TABLE, "%s: LPM rule add failed\n", __func__);
 259                 return -1;
 260         }
 261
 262         /* Commit NHT changes */
 263         lpm->nht_users[nht_pos]++;
 264         lpm->nht_users[nht_pos0] -= nht_pos0_valid;
 265
 266         *key_found = nht_pos0_valid;
 267         *entry_ptr = (void *) &lpm->nht[nht_pos * lpm->entry_size];
 268         return 0;
 269 }
 270
 271 static int
 272 rte_table_lpm_entry_delete(
 273         void *table,
 274         void *key,
 275         int *key_found,
 276         void *entry)
 277 {
 278         struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
 279         struct rte_table_lpm_key *ip_prefix = (struct rte_table_lpm_key *) key;
 280         uint32_t nht_pos;
 281         int status;
 282
 283         /* Check input parameters */
 284         if (lpm == NULL) {
 285                 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
 286                 return -EINVAL;
 287         }
 288         if (ip_prefix == NULL) {
 289                 RTE_LOG(ERR, TABLE, "%s: ip_prefix parameter is NULL\n",
 290                         __func__);
 291                 return -EINVAL;
 292         }
 293         if ((ip_prefix->depth == 0) || (ip_prefix->depth > 32)) {
 294                 RTE_LOG(ERR, TABLE, "%s: invalid depth (%d)\n", __func__,
 295                         ip_prefix->depth);
 296                 return -EINVAL;
 297         }
 298
 299         /* Return if rule is not present in the table */
 300         status = rte_lpm_is_rule_present(lpm->lpm, ip_prefix->ip,
 301                 ip_prefix->depth, &nht_pos);
 302         if (status < 0) {
 303                 RTE_LOG(ERR, TABLE, "%s: LPM algorithmic error\n", __func__);
 304                 return -1;
 305         }
 306         if (status == 0) {
 307                 *key_found = 0;
 308                 return 0;
 309         }
 310
 311         /* Delete rule from the low-level LPM table */
 312         status = rte_lpm_delete(lpm->lpm, ip_prefix->ip, ip_prefix->depth);
 313         if (status) {
 314                 RTE_LOG(ERR, TABLE, "%s: LPM rule delete failed\n", __func__);
 315                 return -1;
 316         }
 317
 318         /* Commit NHT changes */
 319         lpm->nht_users[nht_pos]--;
 320
 321         *key_found = 1;
 322         if (entry)
 323                 memcpy(entry, &lpm->nht[nht_pos * lpm->entry_size],
 324                         lpm->entry_size);
 325
 326         return 0;
 327 }
 328
 329 static int
 330 rte_table_lpm_lookup(
 331         void *table,
 332         struct rte_mbuf **pkts,
 333         uint64_t pkts_mask,
 334         uint64_t *lookup_hit_mask,
 335         void **entries)
 336 {
 337         struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
 338         uint64_t pkts_out_mask = 0;
 339         uint32_t i;
 340
 341         __rte_unused uint32_t n_pkts_in = __builtin_popcountll(pkts_mask);
 342         RTE_TABLE_LPM_STATS_PKTS_IN_ADD(lpm, n_pkts_in);
 343
 344         pkts_out_mask = 0;
 345         for (i = 0; i < (uint32_t)(RTE_PORT_IN_BURST_SIZE_MAX -
 346                 __builtin_clzll(pkts_mask)); i++) {
 347                 uint64_t pkt_mask = 1LLU << i;
 348
 349                 if (pkt_mask & pkts_mask) {
 350                         struct rte_mbuf *pkt = pkts[i];
 351                         uint32_t ip = rte_bswap32(
 352                                 RTE_MBUF_METADATA_UINT32(pkt, lpm->offset));
 353                         int status;
 354                         uint32_t nht_pos;
 355
 356                         status = rte_lpm_lookup(lpm->lpm, ip, &nht_pos);
 357                         if (status == 0) {
 358                                 pkts_out_mask |= pkt_mask;
 359                                 entries[i] = (void *) &lpm->nht[nht_pos *
 360                                         lpm->entry_size];
 361                         }
 362                 }
 363         }
 364
 365         *lookup_hit_mask = pkts_out_mask;
 366         RTE_TABLE_LPM_STATS_PKTS_LOOKUP_MISS(lpm, n_pkts_in - __builtin_popcountll(pkts_out_mask));
 367         return 0;
 368 }
 369
 370 static int
 371 rte_table_lpm_stats_read(void *table, struct rte_table_stats *stats, int clear)
 372 {
 373         struct rte_table_lpm *t = (struct rte_table_lpm *) table;
 374
 375         if (stats != NULL)
 376                 memcpy(stats, &t->stats, sizeof(t->stats));
 377
 378         if (clear)
 379                 memset(&t->stats, 0, sizeof(t->stats));
 380
 381         return 0;
 382 }
 383
 384 struct rte_table_ops rte_table_lpm_ops = {
 385         .f_create = rte_table_lpm_create,
 386         .f_free = rte_table_lpm_free,
 387         .f_add = rte_table_lpm_entry_add,
 388         .f_delete = rte_table_lpm_entry_delete,
 389         .f_add_bulk = NULL,
 390         .f_delete_bulk = NULL,
 391         .f_lookup = rte_table_lpm_lookup,
 392         .f_stats = rte_table_lpm_stats_read,
 393 };