lib/librte_lpm/rte_lpm.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_LPM_H_
   6 #define _RTE_LPM_H_
   7
   8 /**
   9  * @file
  10  * RTE Longest Prefix Match (LPM)
  11  */
  12
  13 #include <errno.h>
  14 #include <sys/queue.h>
  15 #include <stdint.h>
  16 #include <stdlib.h>
  17 #include <rte_branch_prediction.h>
  18 #include <rte_byteorder.h>
  19 #include <rte_config.h>
  20 #include <rte_memory.h>
  21 #include <rte_common.h>
  22 #include <rte_vect.h>
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /** Max number of characters in LPM name. */
  29 #define RTE_LPM_NAMESIZE                32
  30
  31 /** Maximum depth value possible for IPv4 LPM. */
  32 #define RTE_LPM_MAX_DEPTH               32
  33
  34 /** @internal Total number of tbl24 entries. */
  35 #define RTE_LPM_TBL24_NUM_ENTRIES       (1 << 24)
  36
  37 /** @internal Number of entries in a tbl8 group. */
  38 #define RTE_LPM_TBL8_GROUP_NUM_ENTRIES  256
  39
  40 /** @internal Max number of tbl8 groups in the tbl8. */
  41 #define RTE_LPM_MAX_TBL8_NUM_GROUPS         (1 << 24)
  42
  43 /** @internal Total number of tbl8 groups in the tbl8. */
  44 #define RTE_LPM_TBL8_NUM_GROUPS         256
  45
  46 /** @internal Total number of tbl8 entries. */
  47 #define RTE_LPM_TBL8_NUM_ENTRIES        (RTE_LPM_TBL8_NUM_GROUPS * \
  48                                         RTE_LPM_TBL8_GROUP_NUM_ENTRIES)
  49
  50 /** @internal Macro to enable/disable run-time checks. */
  51 #if defined(RTE_LIBRTE_LPM_DEBUG)
  52 #define RTE_LPM_RETURN_IF_TRUE(cond, retval) do { \
  53         if (cond) return (retval);                \
  54 } while (0)
  55 #else
  56 #define RTE_LPM_RETURN_IF_TRUE(cond, retval)
  57 #endif
  58
  59 /** @internal bitmask with valid and valid_group fields set */
  60 #define RTE_LPM_VALID_EXT_ENTRY_BITMASK 0x03000000
  61
  62 /** Bitmask used to indicate successful lookup */
  63 #define RTE_LPM_LOOKUP_SUCCESS          0x01000000
  64
  65 #if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
  66 /** @internal Tbl24 entry structure. */
  67 __extension__
  68 struct rte_lpm_tbl_entry {
  69         /**
  70          * Stores Next hop (tbl8 or tbl24 when valid_group is not set) or
  71          * a group index pointing to a tbl8 structure (tbl24 only, when
  72          * valid_group is set)
  73          */
  74         uint32_t next_hop    :24;
  75         /* Using single uint8_t to store 3 values. */
  76         uint32_t valid       :1;   /**< Validation flag. */
  77         /**
  78          * For tbl24:
  79          *  - valid_group == 0: entry stores a next hop
  80          *  - valid_group == 1: entry stores a group_index pointing to a tbl8
  81          * For tbl8:
  82          *  - valid_group indicates whether the current tbl8 is in use or not
  83          */
  84         uint32_t valid_group :1;
  85         uint32_t depth       :6; /**< Rule depth. */
  86 };
  87
  88 #else
  89
  90 __extension__
  91 struct rte_lpm_tbl_entry {
  92         uint32_t depth       :6;
  93         uint32_t valid_group :1;
  94         uint32_t valid       :1;
  95         uint32_t next_hop    :24;
  96
  97 };
  98
  99 #endif
 100
 101 /** LPM configuration structure. */
 102 struct rte_lpm_config {
 103         uint32_t max_rules;      /**< Max number of rules. */
 104         uint32_t number_tbl8s;   /**< Number of tbl8s to allocate. */
 105         int flags;               /**< This field is currently unused. */
 106 };
 107
 108 /** @internal Rule structure. */
 109 struct rte_lpm_rule {
 110         uint32_t ip; /**< Rule IP address. */
 111         uint32_t next_hop; /**< Rule next hop. */
 112 };
 113
 114 /** @internal Contains metadata about the rules table. */
 115 struct rte_lpm_rule_info {
 116         uint32_t used_rules; /**< Used rules so far. */
 117         uint32_t first_rule; /**< Indexes the first rule of a given depth. */
 118 };
 119
 120 /** @internal LPM structure. */
 121 struct rte_lpm {
 122         /* LPM metadata. */
 123         char name[RTE_LPM_NAMESIZE];        /**< Name of the lpm. */
 124         uint32_t max_rules; /**< Max. balanced rules per lpm. */
 125         uint32_t number_tbl8s; /**< Number of tbl8s. */
 126         struct rte_lpm_rule_info rule_info[RTE_LPM_MAX_DEPTH]; /**< Rule info table. */
 127
 128         /* LPM Tables. */
 129         struct rte_lpm_tbl_entry tbl24[RTE_LPM_TBL24_NUM_ENTRIES]
 130                         __rte_cache_aligned; /**< LPM tbl24 table. */
 131         struct rte_lpm_tbl_entry *tbl8; /**< LPM tbl8 table. */
 132         struct rte_lpm_rule *rules_tbl; /**< LPM rules. */
 133 };
 134
 135 /**
 136  * Create an LPM object.
 137  *
 138  * @param name
 139  *   LPM object name
 140  * @param socket_id
 141  *   NUMA socket ID for LPM table memory allocation
 142  * @param config
 143  *   Structure containing the configuration
 144  * @return
 145  *   Handle to LPM object on success, NULL otherwise with rte_errno set
 146  *   to an appropriate values. Possible rte_errno values include:
 147  *    - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
 148  *    - E_RTE_SECONDARY - function was called from a secondary process instance
 149  *    - EINVAL - invalid parameter passed to function
 150  *    - ENOSPC - the maximum number of memzones has already been allocated
 151  *    - EEXIST - a memzone with the same name already exists
 152  *    - ENOMEM - no appropriate memory area found in which to create memzone
 153  */
 154 struct rte_lpm *
 155 rte_lpm_create(const char *name, int socket_id,
 156                 const struct rte_lpm_config *config);
 157
 158 /**
 159  * Find an existing LPM object and return a pointer to it.
 160  *
 161  * @param name
 162  *   Name of the lpm object as passed to rte_lpm_create()
 163  * @return
 164  *   Pointer to lpm object or NULL if object not found with rte_errno
 165  *   set appropriately. Possible rte_errno values include:
 166  *    - ENOENT - required entry not available to return.
 167  */
 168 struct rte_lpm *
 169 rte_lpm_find_existing(const char *name);
 170
 171 /**
 172  * Free an LPM object.
 173  *
 174  * @param lpm
 175  *   LPM object handle
 176  * @return
 177  *   None
 178  */
 179 void
 180 rte_lpm_free(struct rte_lpm *lpm);
 181
 182 /**
 183  * Add a rule to the LPM table.
 184  *
 185  * @param lpm
 186  *   LPM object handle
 187  * @param ip
 188  *   IP of the rule to be added to the LPM table
 189  * @param depth
 190  *   Depth of the rule to be added to the LPM table
 191  * @param next_hop
 192  *   Next hop of the rule to be added to the LPM table
 193  * @return
 194  *   0 on success, negative value otherwise
 195  */
 196 int
 197 rte_lpm_add(struct rte_lpm *lpm, uint32_t ip, uint8_t depth, uint32_t next_hop);
 198
 199 /**
 200  * Check if a rule is present in the LPM table,
 201  * and provide its next hop if it is.
 202  *
 203  * @param lpm
 204  *   LPM object handle
 205  * @param ip
 206  *   IP of the rule to be searched
 207  * @param depth
 208  *   Depth of the rule to searched
 209  * @param next_hop
 210  *   Next hop of the rule (valid only if it is found)
 211  * @return
 212  *   1 if the rule exists, 0 if it does not, a negative value on failure
 213  */
 214 int
 215 rte_lpm_is_rule_present(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
 216 uint32_t *next_hop);
 217
 218 /**
 219  * Delete a rule from the LPM table.
 220  *
 221  * @param lpm
 222  *   LPM object handle
 223  * @param ip
 224  *   IP of the rule to be deleted from the LPM table
 225  * @param depth
 226  *   Depth of the rule to be deleted from the LPM table
 227  * @return
 228  *   0 on success, negative value otherwise
 229  */
 230 int
 231 rte_lpm_delete(struct rte_lpm *lpm, uint32_t ip, uint8_t depth);
 232
 233 /**
 234  * Delete all rules from the LPM table.
 235  *
 236  * @param lpm
 237  *   LPM object handle
 238  */
 239 void
 240 rte_lpm_delete_all(struct rte_lpm *lpm);
 241
 242 /**
 243  * Lookup an IP into the LPM table.
 244  *
 245  * @param lpm
 246  *   LPM object handle
 247  * @param ip
 248  *   IP to be looked up in the LPM table
 249  * @param next_hop
 250  *   Next hop of the most specific rule found for IP (valid on lookup hit only)
 251  * @return
 252  *   -EINVAL for incorrect arguments, -ENOENT on lookup miss, 0 on lookup hit
 253  */
 254 static inline int
 255 rte_lpm_lookup(struct rte_lpm *lpm, uint32_t ip, uint32_t *next_hop)
 256 {
 257         unsigned tbl24_index = (ip >> 8);
 258         uint32_t tbl_entry;
 259         const uint32_t *ptbl;
 260
 261         /* DEBUG: Check user input arguments. */
 262         RTE_LPM_RETURN_IF_TRUE(((lpm == NULL) || (next_hop == NULL)), -EINVAL);
 263
 264         /* Copy tbl24 entry */
 265         ptbl = (const uint32_t *)(&lpm->tbl24[tbl24_index]);
 266         tbl_entry = *ptbl;
 267
 268         /* Memory ordering is not required in lookup. Because dataflow
 269          * dependency exists, compiler or HW won't be able to re-order
 270          * the operations.
 271          */
 272         /* Copy tbl8 entry (only if needed) */
 273         if (unlikely((tbl_entry & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
 274                         RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
 275
 276                 unsigned tbl8_index = (uint8_t)ip +
 277                                 (((uint32_t)tbl_entry & 0x00FFFFFF) *
 278                                                 RTE_LPM_TBL8_GROUP_NUM_ENTRIES);
 279
 280                 ptbl = (const uint32_t *)&lpm->tbl8[tbl8_index];
 281                 tbl_entry = *ptbl;
 282         }
 283
 284         *next_hop = ((uint32_t)tbl_entry & 0x00FFFFFF);
 285         return (tbl_entry & RTE_LPM_LOOKUP_SUCCESS) ? 0 : -ENOENT;
 286 }
 287
 288 /**
 289  * Lookup multiple IP addresses in an LPM table. This may be implemented as a
 290  * macro, so the address of the function should not be used.
 291  *
 292  * @param lpm
 293  *   LPM object handle
 294  * @param ips
 295  *   Array of IPs to be looked up in the LPM table
 296  * @param next_hops
 297  *   Next hop of the most specific rule found for IP (valid on lookup hit only).
 298  *   This is an array of two byte values. The most significant byte in each
 299  *   value says whether the lookup was successful (bitmask
 300  *   RTE_LPM_LOOKUP_SUCCESS is set). The least significant byte is the
 301  *   actual next hop.
 302  * @param n
 303  *   Number of elements in ips (and next_hops) array to lookup. This should be a
 304  *   compile time constant, and divisible by 8 for best performance.
 305  *  @return
 306  *   -EINVAL for incorrect arguments, otherwise 0
 307  */
 308 #define rte_lpm_lookup_bulk(lpm, ips, next_hops, n) \
 309                 rte_lpm_lookup_bulk_func(lpm, ips, next_hops, n)
 310
 311 static inline int
 312 rte_lpm_lookup_bulk_func(const struct rte_lpm *lpm, const uint32_t *ips,
 313                 uint32_t *next_hops, const unsigned n)
 314 {
 315         unsigned i;
 316         unsigned tbl24_indexes[n];
 317         const uint32_t *ptbl;
 318
 319         /* DEBUG: Check user input arguments. */
 320         RTE_LPM_RETURN_IF_TRUE(((lpm == NULL) || (ips == NULL) ||
 321                         (next_hops == NULL)), -EINVAL);
 322
 323         for (i = 0; i < n; i++) {
 324                 tbl24_indexes[i] = ips[i] >> 8;
 325         }
 326
 327         for (i = 0; i < n; i++) {
 328                 /* Simply copy tbl24 entry to output */
 329                 ptbl = (const uint32_t *)&lpm->tbl24[tbl24_indexes[i]];
 330                 next_hops[i] = *ptbl;
 331
 332                 /* Overwrite output with tbl8 entry if needed */
 333                 if (unlikely((next_hops[i] & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
 334                                 RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
 335
 336                         unsigned tbl8_index = (uint8_t)ips[i] +
 337                                         (((uint32_t)next_hops[i] & 0x00FFFFFF) *
 338                                          RTE_LPM_TBL8_GROUP_NUM_ENTRIES);
 339
 340                         ptbl = (const uint32_t *)&lpm->tbl8[tbl8_index];
 341                         next_hops[i] = *ptbl;
 342                 }
 343         }
 344         return 0;
 345 }
 346
 347 /* Mask four results. */
 348 #define  RTE_LPM_MASKX4_RES     UINT64_C(0x00ffffff00ffffff)
 349
 350 /**
 351  * Lookup four IP addresses in an LPM table.
 352  *
 353  * @param lpm
 354  *   LPM object handle
 355  * @param ip
 356  *   Four IPs to be looked up in the LPM table
 357  * @param hop
 358  *   Next hop of the most specific rule found for IP (valid on lookup hit only).
 359  *   This is an 4 elements array of two byte values.
 360  *   If the lookup was successful for the given IP, then least significant byte
 361  *   of the corresponding element is the  actual next hop and the most
 362  *   significant byte is zero.
 363  *   If the lookup for the given IP failed, then corresponding element would
 364  *   contain default value, see description of then next parameter.
 365  * @param defv
 366  *   Default value to populate into corresponding element of hop[] array,
 367  *   if lookup would fail.
 368  */
 369 static inline void
 370 rte_lpm_lookupx4(const struct rte_lpm *lpm, xmm_t ip, uint32_t hop[4],
 371         uint32_t defv);
 372
 373 #if defined(RTE_ARCH_ARM) || defined(RTE_ARCH_ARM64)
 374 #include "rte_lpm_neon.h"
 375 #elif defined(RTE_ARCH_PPC_64)
 376 #include "rte_lpm_altivec.h"
 377 #else
 378 #include "rte_lpm_sse.h"
 379 #endif
 380
 381 #ifdef __cplusplus
 382 }
 383 #endif
 384
 385 #endif /* _RTE_LPM_H_ */