lib/librte_lpm/rte_lpm.h

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