lib/librte_lpm/rte_lpm.h

   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 #ifndef _RTE_LPM_H_
  35 #define _RTE_LPM_H_
  36
  37 /**
  38  * @file
  39  * RTE Longest Prefix Match (LPM)
  40  */
  41
  42 #include <errno.h>
  43 #include <sys/queue.h>
  44 #include <stdint.h>
  45 #include <stdlib.h>
  46 #include <rte_branch_prediction.h>
  47 #include <rte_memory.h>
  48 #include <rte_common.h>
  49 #include <rte_vect.h>
  50
  51 #ifdef __cplusplus
  52 extern "C" {
  53 #endif
  54
  55 /** Max number of characters in LPM name. */
  56 #define RTE_LPM_NAMESIZE                32
  57
  58 /** @deprecated Possible location to allocate memory. This was for last
  59  * parameter of rte_lpm_create(), but is now redundant. The LPM table is always
  60  * allocated in memory using librte_malloc which uses a memzone. */
  61 #define RTE_LPM_HEAP                    0
  62
  63 /** @deprecated Possible location to allocate memory. This was for last
  64  * parameter of rte_lpm_create(), but is now redundant. The LPM table is always
  65  * allocated in memory using librte_malloc which uses a memzone. */
  66 #define RTE_LPM_MEMZONE                 1
  67
  68 /** Maximum depth value possible for IPv4 LPM. */
  69 #define RTE_LPM_MAX_DEPTH               32
  70
  71 /** @internal Total number of tbl24 entries. */
  72 #define RTE_LPM_TBL24_NUM_ENTRIES       (1 << 24)
  73
  74 /** @internal Number of entries in a tbl8 group. */
  75 #define RTE_LPM_TBL8_GROUP_NUM_ENTRIES  256
  76
  77 /** @internal Total number of tbl8 groups in the tbl8. */
  78 #define RTE_LPM_TBL8_NUM_GROUPS         256
  79
  80 /** @internal Total number of tbl8 entries. */
  81 #define RTE_LPM_TBL8_NUM_ENTRIES        (RTE_LPM_TBL8_NUM_GROUPS * \
  82                                         RTE_LPM_TBL8_GROUP_NUM_ENTRIES)
  83
  84 /** @internal Macro to enable/disable run-time checks. */
  85 #if defined(RTE_LIBRTE_LPM_DEBUG)
  86 #define RTE_LPM_RETURN_IF_TRUE(cond, retval) do { \
  87         if (cond) return (retval);                \
  88 } while (0)
  89 #else
  90 #define RTE_LPM_RETURN_IF_TRUE(cond, retval)
  91 #endif
  92
  93 /** @internal bitmask with valid and ext_entry/valid_group fields set */
  94 #define RTE_LPM_VALID_EXT_ENTRY_BITMASK 0x0300
  95
  96 /** Bitmask used to indicate successful lookup */
  97 #define RTE_LPM_LOOKUP_SUCCESS          0x0100
  98
  99 /** @internal Tbl24 entry structure. */
 100 struct rte_lpm_tbl24_entry {
 101         /* Stores Next hop or group index (i.e. gindex)into tbl8. */
 102         union {
 103                 uint8_t next_hop;
 104                 uint8_t tbl8_gindex;
 105         };
 106         /* Using single uint8_t to store 3 values. */
 107         uint8_t valid     :1; /**< Validation flag. */
 108         uint8_t ext_entry :1; /**< External entry. */
 109         uint8_t depth     :6; /**< Rule depth. */
 110 };
 111
 112 /** @internal Tbl8 entry structure. */
 113 struct rte_lpm_tbl8_entry {
 114         uint8_t next_hop; /**< next hop. */
 115         /* Using single uint8_t to store 3 values. */
 116         uint8_t valid       :1; /**< Validation flag. */
 117         uint8_t valid_group :1; /**< Group validation flag. */
 118         uint8_t depth       :6; /**< Rule depth. */
 119 };
 120
 121 /** @internal Rule structure. */
 122 struct rte_lpm_rule {
 123         uint32_t ip; /**< Rule IP address. */
 124         uint8_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         int mem_location; /**< @deprecated @see RTE_LPM_HEAP and RTE_LPM_MEMZONE. */
 138         uint32_t max_rules; /**< Max. balanced rules per lpm. */
 139         struct rte_lpm_rule_info rule_info[RTE_LPM_MAX_DEPTH]; /**< Rule info table. */
 140
 141         /* LPM Tables. */
 142         struct rte_lpm_tbl24_entry tbl24[RTE_LPM_TBL24_NUM_ENTRIES] \
 143                         __rte_cache_aligned; /**< LPM tbl24 table. */
 144         struct rte_lpm_tbl8_entry tbl8[RTE_LPM_TBL8_NUM_ENTRIES] \
 145                         __rte_cache_aligned; /**< LPM tbl8 table. */
 146         struct rte_lpm_rule rules_tbl[0] \
 147                         __rte_cache_aligned; /**< LPM rules. */
 148 };
 149
 150 /**
 151  * Create an LPM object.
 152  *
 153  * @param name
 154  *   LPM object name
 155  * @param socket_id
 156  *   NUMA socket ID for LPM table memory allocation
 157  * @param max_rules
 158  *   Maximum number of LPM rules that can be added
 159  * @param flags
 160  *   This parameter is currently unused
 161  * @return
 162  *   Handle to LPM object on success, NULL otherwise with rte_errno set
 163  *   to an appropriate values. Possible rte_errno values include:
 164  *    - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
 165  *    - E_RTE_SECONDARY - function was called from a secondary process instance
 166  *    - EINVAL - invalid parameter passed to function
 167  *    - ENOSPC - the maximum number of memzones has already been allocated
 168  *    - EEXIST - a memzone with the same name already exists
 169  *    - ENOMEM - no appropriate memory area found in which to create memzone
 170  */
 171 struct rte_lpm *
 172 rte_lpm_create(const char *name, int socket_id, int max_rules, int flags);
 173
 174 /**
 175  * Find an existing LPM object and return a pointer to it.
 176  *
 177  * @param name
 178  *   Name of the lpm object as passed to rte_lpm_create()
 179  * @return
 180  *   Pointer to lpm object or NULL if object not found with rte_errno
 181  *   set appropriately. Possible rte_errno values include:
 182  *    - ENOENT - required entry not available to return.
 183  */
 184 struct rte_lpm *
 185 rte_lpm_find_existing(const char *name);
 186
 187 /**
 188  * Free an LPM object.
 189  *
 190  * @param lpm
 191  *   LPM object handle
 192  * @return
 193  *   None
 194  */
 195 void
 196 rte_lpm_free(struct rte_lpm *lpm);
 197
 198 /**
 199  * Add a rule to the LPM table.
 200  *
 201  * @param lpm
 202  *   LPM object handle
 203  * @param ip
 204  *   IP of the rule to be added to the LPM table
 205  * @param depth
 206  *   Depth of the rule to be added to the LPM table
 207  * @param next_hop
 208  *   Next hop of the rule to be added to the LPM table
 209  * @return
 210  *   0 on success, negative value otherwise
 211  */
 212 int
 213 rte_lpm_add(struct rte_lpm *lpm, uint32_t ip, uint8_t depth, uint8_t next_hop);
 214
 215 /**
 216  * Check if a rule is present in the LPM table,
 217  * and provide its next hop if it is.
 218  *
 219  * @param lpm
 220  *   LPM object handle
 221  * @param ip
 222  *   IP of the rule to be searched
 223  * @param depth
 224  *   Depth of the rule to searched
 225  * @param next_hop
 226  *   Next hop of the rule (valid only if it is found)
 227  * @return
 228  *   1 if the rule exists, 0 if it does not, a negative value on failure
 229  */
 230 int
 231 rte_lpm_is_rule_present(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
 232 uint8_t *next_hop);
 233
 234 /**
 235  * Delete a rule from the LPM table.
 236  *
 237  * @param lpm
 238  *   LPM object handle
 239  * @param ip
 240  *   IP of the rule to be deleted from the LPM table
 241  * @param depth
 242  *   Depth of the rule to be deleted from the LPM table
 243  * @return
 244  *   0 on success, negative value otherwise
 245  */
 246 int
 247 rte_lpm_delete(struct rte_lpm *lpm, uint32_t ip, uint8_t depth);
 248
 249 /**
 250  * Delete all rules from the LPM table.
 251  *
 252  * @param lpm
 253  *   LPM object handle
 254  */
 255 void
 256 rte_lpm_delete_all(struct rte_lpm *lpm);
 257
 258 /**
 259  * Lookup an IP into the LPM table.
 260  *
 261  * @param lpm
 262  *   LPM object handle
 263  * @param ip
 264  *   IP to be looked up in the LPM table
 265  * @param next_hop
 266  *   Next hop of the most specific rule found for IP (valid on lookup hit only)
 267  * @return
 268  *   -EINVAL for incorrect arguments, -ENOENT on lookup miss, 0 on lookup hit
 269  */
 270 static inline int
 271 rte_lpm_lookup(struct rte_lpm *lpm, uint32_t ip, uint8_t *next_hop)
 272 {
 273         unsigned tbl24_index = (ip >> 8);
 274         uint16_t tbl_entry;
 275
 276         /* DEBUG: Check user input arguments. */
 277         RTE_LPM_RETURN_IF_TRUE(((lpm == NULL) || (next_hop == NULL)), -EINVAL);
 278
 279         /* Copy tbl24 entry */
 280         tbl_entry = *(const uint16_t *)&lpm->tbl24[tbl24_index];
 281
 282         /* Copy tbl8 entry (only if needed) */
 283         if (unlikely((tbl_entry & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
 284                         RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
 285
 286                 unsigned tbl8_index = (uint8_t)ip +
 287                                 ((uint8_t)tbl_entry * RTE_LPM_TBL8_GROUP_NUM_ENTRIES);
 288
 289                 tbl_entry = *(const uint16_t *)&lpm->tbl8[tbl8_index];
 290         }
 291
 292         *next_hop = (uint8_t)tbl_entry;
 293         return (tbl_entry & RTE_LPM_LOOKUP_SUCCESS) ? 0 : -ENOENT;
 294 }
 295
 296 /**
 297  * Lookup multiple IP addresses in an LPM table. This may be implemented as a
 298  * macro, so the address of the function should not be used.
 299  *
 300  * @param lpm
 301  *   LPM object handle
 302  * @param ips
 303  *   Array of IPs to be looked up in the LPM table
 304  * @param next_hops
 305  *   Next hop of the most specific rule found for IP (valid on lookup hit only).
 306  *   This is an array of two byte values. The most significant byte in each
 307  *   value says whether the lookup was successful (bitmask
 308  *   RTE_LPM_LOOKUP_SUCCESS is set). The least significant byte is the
 309  *   actual next hop.
 310  * @param n
 311  *   Number of elements in ips (and next_hops) array to lookup. This should be a
 312  *   compile time constant, and divisible by 8 for best performance.
 313  *  @return
 314  *   -EINVAL for incorrect arguments, otherwise 0
 315  */
 316 #define rte_lpm_lookup_bulk(lpm, ips, next_hops, n) \
 317                 rte_lpm_lookup_bulk_func(lpm, ips, next_hops, n)
 318
 319 static inline int
 320 rte_lpm_lookup_bulk_func(const struct rte_lpm *lpm, const uint32_t * ips,
 321                 uint16_t * next_hops, const unsigned n)
 322 {
 323         unsigned i;
 324         unsigned tbl24_indexes[n];
 325
 326         /* DEBUG: Check user input arguments. */
 327         RTE_LPM_RETURN_IF_TRUE(((lpm == NULL) || (ips == NULL) ||
 328                         (next_hops == NULL)), -EINVAL);
 329
 330         for (i = 0; i < n; i++) {
 331                 tbl24_indexes[i] = ips[i] >> 8;
 332         }
 333
 334         for (i = 0; i < n; i++) {
 335                 /* Simply copy tbl24 entry to output */
 336                 next_hops[i] = *(const uint16_t *)&lpm->tbl24[tbl24_indexes[i]];
 337
 338                 /* Overwrite output with tbl8 entry if needed */
 339                 if (unlikely((next_hops[i] & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
 340                                 RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
 341
 342                         unsigned tbl8_index = (uint8_t)ips[i] +
 343                                         ((uint8_t)next_hops[i] *
 344                                          RTE_LPM_TBL8_GROUP_NUM_ENTRIES);
 345
 346                         next_hops[i] = *(const uint16_t *)&lpm->tbl8[tbl8_index];
 347                 }
 348         }
 349         return 0;
 350 }
 351
 352 /* Mask four results. */
 353 #define  RTE_LPM_MASKX4_RES     UINT64_C(0x00ff00ff00ff00ff)
 354
 355 /**
 356  * Lookup four IP addresses in an LPM table.
 357  *
 358  * @param lpm
 359  *   LPM object handle
 360  * @param ip
 361  *   Four IPs to be looked up in the LPM table
 362  * @param hop
 363  *   Next hop of the most specific rule found for IP (valid on lookup hit only).
 364  *   This is an 4 elements array of two byte values.
 365  *   If the lookup was succesfull for the given IP, then least significant byte
 366  *   of the corresponding element is the  actual next hop and the most
 367  *   significant byte is zero.
 368  *   If the lookup for the given IP failed, then corresponding element would
 369  *   contain default value, see description of then next parameter.
 370  * @param defv
 371  *   Default value to populate into corresponding element of hop[] array,
 372  *   if lookup would fail.
 373  */
 374 static inline void
 375 rte_lpm_lookupx4(const struct rte_lpm *lpm, __m128i ip, uint16_t hop[4],
 376         uint16_t defv)
 377 {
 378         __m128i i24;
 379         rte_xmm_t i8;
 380         uint16_t tbl[4];
 381         uint64_t idx, pt;
 382
 383         const __m128i mask8 =
 384                 _mm_set_epi32(UINT8_MAX, UINT8_MAX, UINT8_MAX, UINT8_MAX);
 385
 386         /*
 387          * RTE_LPM_VALID_EXT_ENTRY_BITMASK for 4 LPM entries
 388          * as one 64-bit value (0x0300030003000300).
 389          */
 390         const uint64_t mask_xv =
 391                 ((uint64_t)RTE_LPM_VALID_EXT_ENTRY_BITMASK |
 392                 (uint64_t)RTE_LPM_VALID_EXT_ENTRY_BITMASK << 16 |
 393                 (uint64_t)RTE_LPM_VALID_EXT_ENTRY_BITMASK << 32 |
 394                 (uint64_t)RTE_LPM_VALID_EXT_ENTRY_BITMASK << 48);
 395
 396         /*
 397          * RTE_LPM_LOOKUP_SUCCESS for 4 LPM entries
 398          * as one 64-bit value (0x0100010001000100).
 399          */
 400         const uint64_t mask_v =
 401                 ((uint64_t)RTE_LPM_LOOKUP_SUCCESS |
 402                 (uint64_t)RTE_LPM_LOOKUP_SUCCESS << 16 |
 403                 (uint64_t)RTE_LPM_LOOKUP_SUCCESS << 32 |
 404                 (uint64_t)RTE_LPM_LOOKUP_SUCCESS << 48);
 405
 406         /* get 4 indexes for tbl24[]. */
 407         i24 = _mm_srli_epi32(ip, CHAR_BIT);
 408
 409         /* extract values from tbl24[] */
 410         idx = _mm_cvtsi128_si64(i24);
 411         i24 = _mm_srli_si128(i24, sizeof(uint64_t));
 412
 413         tbl[0] = *(const uint16_t *)&lpm->tbl24[(uint32_t)idx];
 414         tbl[1] = *(const uint16_t *)&lpm->tbl24[idx >> 32];
 415
 416         idx = _mm_cvtsi128_si64(i24);
 417
 418         tbl[2] = *(const uint16_t *)&lpm->tbl24[(uint32_t)idx];
 419         tbl[3] = *(const uint16_t *)&lpm->tbl24[idx >> 32];
 420
 421         /* get 4 indexes for tbl8[]. */
 422         i8.x = _mm_and_si128(ip, mask8);
 423
 424         pt = (uint64_t)tbl[0] |
 425                 (uint64_t)tbl[1] << 16 |
 426                 (uint64_t)tbl[2] << 32 |
 427                 (uint64_t)tbl[3] << 48;
 428
 429         /* search successfully finished for all 4 IP addresses. */
 430         if (likely((pt & mask_xv) == mask_v)) {
 431                 uintptr_t ph = (uintptr_t)hop;
 432                 *(uint64_t *)ph = pt & RTE_LPM_MASKX4_RES;
 433                 return;
 434         }
 435
 436         if (unlikely((pt & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
 437                         RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
 438                 i8.u32[0] = i8.u32[0] +
 439                         (uint8_t)tbl[0] * RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
 440                 tbl[0] = *(const uint16_t *)&lpm->tbl8[i8.u32[0]];
 441         }
 442         if (unlikely((pt >> 16 & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
 443                         RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
 444                 i8.u32[1] = i8.u32[1] +
 445                         (uint8_t)tbl[1] * RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
 446                 tbl[1] = *(const uint16_t *)&lpm->tbl8[i8.u32[1]];
 447         }
 448         if (unlikely((pt >> 32 & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
 449                         RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
 450                 i8.u32[2] = i8.u32[2] +
 451                         (uint8_t)tbl[2] * RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
 452                 tbl[2] = *(const uint16_t *)&lpm->tbl8[i8.u32[2]];
 453         }
 454         if (unlikely((pt >> 48 & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
 455                         RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
 456                 i8.u32[3] = i8.u32[3] +
 457                         (uint8_t)tbl[3] * RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
 458                 tbl[3] = *(const uint16_t *)&lpm->tbl8[i8.u32[3]];
 459         }
 460
 461         hop[0] = (tbl[0] & RTE_LPM_LOOKUP_SUCCESS) ? (uint8_t)tbl[0] : defv;
 462         hop[1] = (tbl[1] & RTE_LPM_LOOKUP_SUCCESS) ? (uint8_t)tbl[1] : defv;
 463         hop[2] = (tbl[2] & RTE_LPM_LOOKUP_SUCCESS) ? (uint8_t)tbl[2] : defv;
 464         hop[3] = (tbl[3] & RTE_LPM_LOOKUP_SUCCESS) ? (uint8_t)tbl[3] : defv;
 465 }
 466
 467 #ifdef __cplusplus
 468 }
 469 #endif
 470
 471 #endif /* _RTE_LPM_H_ */