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_common_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         TAILQ_ENTRY(rte_lpm) next;      /**< Next in list. */
 136
 137         /* LPM metadata. */
 138         char name[RTE_LPM_NAMESIZE];        /**< Name of the lpm. */
 139         int mem_location; /**< @deprecated @see RTE_LPM_HEAP and RTE_LPM_MEMZONE. */
 140         uint32_t max_rules; /**< Max. balanced rules per lpm. */
 141         struct rte_lpm_rule_info rule_info[RTE_LPM_MAX_DEPTH]; /**< Rule info table. */
 142
 143         /* LPM Tables. */
 144         struct rte_lpm_tbl24_entry tbl24[RTE_LPM_TBL24_NUM_ENTRIES] \
 145                         __rte_cache_aligned; /**< LPM tbl24 table. */
 146         struct rte_lpm_tbl8_entry tbl8[RTE_LPM_TBL8_NUM_ENTRIES] \
 147                         __rte_cache_aligned; /**< LPM tbl8 table. */
 148         struct rte_lpm_rule rules_tbl[0] \
 149                         __rte_cache_aligned; /**< LPM rules. */
 150 };
 151
 152 /**
 153  * Create an LPM object.
 154  *
 155  * @param name
 156  *   LPM object name
 157  * @param socket_id
 158  *   NUMA socket ID for LPM table memory allocation
 159  * @param max_rules
 160  *   Maximum number of LPM rules that can be added
 161  * @param flags
 162  *   This parameter is currently unused
 163  * @return
 164  *   Handle to LPM object on success, NULL otherwise with rte_errno set
 165  *   to an appropriate values. Possible rte_errno values include:
 166  *    - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
 167  *    - E_RTE_SECONDARY - function was called from a secondary process instance
 168  *    - E_RTE_NO_TAILQ - no tailq list could be got for the lpm object list
 169  *    - EINVAL - invalid parameter passed to function
 170  *    - ENOSPC - the maximum number of memzones has already been allocated
 171  *    - EEXIST - a memzone with the same name already exists
 172  *    - ENOMEM - no appropriate memory area found in which to create memzone
 173  */
 174 struct rte_lpm *
 175 rte_lpm_create(const char *name, int socket_id, int max_rules, int flags);
 176
 177 /**
 178  * Find an existing LPM object and return a pointer to it.
 179  *
 180  * @param name
 181  *   Name of the lpm object as passed to rte_lpm_create()
 182  * @return
 183  *   Pointer to lpm object or NULL if object not found with rte_errno
 184  *   set appropriately. Possible rte_errno values include:
 185  *    - ENOENT - required entry not available to return.
 186  */
 187 struct rte_lpm *
 188 rte_lpm_find_existing(const char *name);
 189
 190 /**
 191  * Free an LPM object.
 192  *
 193  * @param lpm
 194  *   LPM object handle
 195  * @return
 196  *   None
 197  */
 198 void
 199 rte_lpm_free(struct rte_lpm *lpm);
 200
 201 /**
 202  * Add a rule to the LPM table.
 203  *
 204  * @param lpm
 205  *   LPM object handle
 206  * @param ip
 207  *   IP of the rule to be added to the LPM table
 208  * @param depth
 209  *   Depth of the rule to be added to the LPM table
 210  * @param next_hop
 211  *   Next hop of the rule to be added to the LPM table
 212  * @return
 213  *   0 on success, negative value otherwise
 214  */
 215 int
 216 rte_lpm_add(struct rte_lpm *lpm, uint32_t ip, uint8_t depth, uint8_t next_hop);
 217
 218 /**
 219  * Check if a rule is present in the LPM table,
 220  * and provide its next hop if it is.
 221  *
 222  * @param lpm
 223  *   LPM object handle
 224  * @param ip
 225  *   IP of the rule to be searched
 226  * @param depth
 227  *   Depth of the rule to searched
 228  * @param next_hop
 229  *   Next hop of the rule (valid only if it is found)
 230  * @return
 231  *   1 if the rule exists, 0 if it does not, a negative value on failure
 232  */
 233 int
 234 rte_lpm_is_rule_present(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
 235 uint8_t *next_hop);
 236
 237 /**
 238  * Delete a rule from the LPM table.
 239  *
 240  * @param lpm
 241  *   LPM object handle
 242  * @param ip
 243  *   IP of the rule to be deleted from the LPM table
 244  * @param depth
 245  *   Depth of the rule to be deleted from the LPM table
 246  * @return
 247  *   0 on success, negative value otherwise
 248  */
 249 int
 250 rte_lpm_delete(struct rte_lpm *lpm, uint32_t ip, uint8_t depth);
 251
 252 /**
 253  * Delete all rules from the LPM table.
 254  *
 255  * @param lpm
 256  *   LPM object handle
 257  */
 258 void
 259 rte_lpm_delete_all(struct rte_lpm *lpm);
 260
 261 /**
 262  * Lookup an IP into the LPM table.
 263  *
 264  * @param lpm
 265  *   LPM object handle
 266  * @param ip
 267  *   IP to be looked up in the LPM table
 268  * @param next_hop
 269  *   Next hop of the most specific rule found for IP (valid on lookup hit only)
 270  * @return
 271  *   -EINVAL for incorrect arguments, -ENOENT on lookup miss, 0 on lookup hit
 272  */
 273 static inline int
 274 rte_lpm_lookup(struct rte_lpm *lpm, uint32_t ip, uint8_t *next_hop)
 275 {
 276         unsigned tbl24_index = (ip >> 8);
 277         uint16_t tbl_entry;
 278
 279         /* DEBUG: Check user input arguments. */
 280         RTE_LPM_RETURN_IF_TRUE(((lpm == NULL) || (next_hop == NULL)), -EINVAL);
 281
 282         /* Copy tbl24 entry */
 283         tbl_entry = *(const uint16_t *)&lpm->tbl24[tbl24_index];
 284
 285         /* Copy tbl8 entry (only if needed) */
 286         if (unlikely((tbl_entry & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
 287                         RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
 288
 289                 unsigned tbl8_index = (uint8_t)ip +
 290                                 ((uint8_t)tbl_entry * RTE_LPM_TBL8_GROUP_NUM_ENTRIES);
 291
 292                 tbl_entry = *(const uint16_t *)&lpm->tbl8[tbl8_index];
 293         }
 294
 295         *next_hop = (uint8_t)tbl_entry;
 296         return (tbl_entry & RTE_LPM_LOOKUP_SUCCESS) ? 0 : -ENOENT;
 297 }
 298
 299 /**
 300  * Lookup multiple IP addresses in an LPM table. This may be implemented as a
 301  * macro, so the address of the function should not be used.
 302  *
 303  * @param lpm
 304  *   LPM object handle
 305  * @param ips
 306  *   Array of IPs to be looked up in the LPM table
 307  * @param next_hops
 308  *   Next hop of the most specific rule found for IP (valid on lookup hit only).
 309  *   This is an array of two byte values. The most significant byte in each
 310  *   value says whether the lookup was successful (bitmask
 311  *   RTE_LPM_LOOKUP_SUCCESS is set). The least significant byte is the
 312  *   actual next hop.
 313  * @param n
 314  *   Number of elements in ips (and next_hops) array to lookup. This should be a
 315  *   compile time constant, and divisible by 8 for best performance.
 316  *  @return
 317  *   -EINVAL for incorrect arguments, otherwise 0
 318  */
 319 #define rte_lpm_lookup_bulk(lpm, ips, next_hops, n) \
 320                 rte_lpm_lookup_bulk_func(lpm, ips, next_hops, n)
 321
 322 static inline int
 323 rte_lpm_lookup_bulk_func(const struct rte_lpm *lpm, const uint32_t * ips,
 324                 uint16_t * next_hops, const unsigned n)
 325 {
 326         unsigned i;
 327         unsigned tbl24_indexes[n];
 328
 329         /* DEBUG: Check user input arguments. */
 330         RTE_LPM_RETURN_IF_TRUE(((lpm == NULL) || (ips == NULL) ||
 331                         (next_hops == NULL)), -EINVAL);
 332
 333         for (i = 0; i < n; i++) {
 334                 tbl24_indexes[i] = ips[i] >> 8;
 335         }
 336
 337         for (i = 0; i < n; i++) {
 338                 /* Simply copy tbl24 entry to output */
 339                 next_hops[i] = *(const uint16_t *)&lpm->tbl24[tbl24_indexes[i]];
 340
 341                 /* Overwrite output with tbl8 entry if needed */
 342                 if (unlikely((next_hops[i] & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
 343                                 RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
 344
 345                         unsigned tbl8_index = (uint8_t)ips[i] +
 346                                         ((uint8_t)next_hops[i] *
 347                                          RTE_LPM_TBL8_GROUP_NUM_ENTRIES);
 348
 349                         next_hops[i] = *(const uint16_t *)&lpm->tbl8[tbl8_index];
 350                 }
 351         }
 352         return 0;
 353 }
 354
 355 /* Mask four results. */
 356 #define  RTE_LPM_MASKX4_RES     UINT64_C(0x00ff00ff00ff00ff)
 357
 358 /**
 359  * Lookup four IP addresses in an LPM table.
 360  *
 361  * @param lpm
 362  *   LPM object handle
 363  * @param ip
 364  *   Four IPs to be looked up in the LPM table
 365  * @param hop
 366  *   Next hop of the most specific rule found for IP (valid on lookup hit only).
 367  *   This is an 4 elements array of two byte values.
 368  *   If the lookup was succesfull for the given IP, then least significant byte
 369  *   of the corresponding element is the  actual next hop and the most
 370  *   significant byte is zero.
 371  *   If the lookup for the given IP failed, then corresponding element would
 372  *   contain default value, see description of then next parameter.
 373  * @param defv
 374  *   Default value to populate into corresponding element of hop[] array,
 375  *   if lookup would fail.
 376  */
 377 static inline void
 378 rte_lpm_lookupx4(const struct rte_lpm *lpm, __m128i ip, uint16_t hop[4],
 379         uint16_t defv)
 380 {
 381         __m128i i24;
 382         rte_xmm_t i8;
 383         uint16_t tbl[4];
 384         uint64_t idx, pt;
 385
 386         const __m128i mask8 =
 387                 _mm_set_epi32(UINT8_MAX, UINT8_MAX, UINT8_MAX, UINT8_MAX);
 388
 389         /*
 390          * RTE_LPM_VALID_EXT_ENTRY_BITMASK for 4 LPM entries
 391          * as one 64-bit value (0x0300030003000300).
 392          */
 393         const uint64_t mask_xv =
 394                 ((uint64_t)RTE_LPM_VALID_EXT_ENTRY_BITMASK |
 395                 (uint64_t)RTE_LPM_VALID_EXT_ENTRY_BITMASK << 16 |
 396                 (uint64_t)RTE_LPM_VALID_EXT_ENTRY_BITMASK << 32 |
 397                 (uint64_t)RTE_LPM_VALID_EXT_ENTRY_BITMASK << 48);
 398
 399         /*
 400          * RTE_LPM_LOOKUP_SUCCESS for 4 LPM entries
 401          * as one 64-bit value (0x0100010001000100).
 402          */
 403         const uint64_t mask_v =
 404                 ((uint64_t)RTE_LPM_LOOKUP_SUCCESS |
 405                 (uint64_t)RTE_LPM_LOOKUP_SUCCESS << 16 |
 406                 (uint64_t)RTE_LPM_LOOKUP_SUCCESS << 32 |
 407                 (uint64_t)RTE_LPM_LOOKUP_SUCCESS << 48);
 408
 409         /* get 4 indexes for tbl24[]. */
 410         i24 = _mm_srli_epi32(ip, CHAR_BIT);
 411
 412         /* extract values from tbl24[] */
 413         idx = _mm_cvtsi128_si64(i24);
 414         i24 = _mm_srli_si128(i24, sizeof(uint64_t));
 415
 416         tbl[0] = *(const uint16_t *)&lpm->tbl24[(uint32_t)idx];
 417         tbl[1] = *(const uint16_t *)&lpm->tbl24[idx >> 32];
 418
 419         idx = _mm_cvtsi128_si64(i24);
 420
 421         tbl[2] = *(const uint16_t *)&lpm->tbl24[(uint32_t)idx];
 422         tbl[3] = *(const uint16_t *)&lpm->tbl24[idx >> 32];
 423
 424         /* get 4 indexes for tbl8[]. */
 425         i8.m = _mm_and_si128(ip, mask8);
 426
 427         pt = (uint64_t)tbl[0] |
 428                 (uint64_t)tbl[1] << 16 |
 429                 (uint64_t)tbl[2] << 32 |
 430                 (uint64_t)tbl[3] << 48;
 431
 432         /* search successfully finished for all 4 IP addresses. */
 433         if (likely((pt & mask_xv) == mask_v)) {
 434                 uintptr_t ph = (uintptr_t)hop;
 435                 *(uint64_t *)ph = pt & RTE_LPM_MASKX4_RES;
 436                 return;
 437         }
 438
 439         if (unlikely((pt & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
 440                         RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
 441                 i8.u32[0] = i8.u32[0] +
 442                         (uint8_t)tbl[0] * RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
 443                 tbl[0] = *(const uint16_t *)&lpm->tbl8[i8.u32[0]];
 444         }
 445         if (unlikely((pt >> 16 & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
 446                         RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
 447                 i8.u32[1] = i8.u32[1] +
 448                         (uint8_t)tbl[1] * RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
 449                 tbl[1] = *(const uint16_t *)&lpm->tbl8[i8.u32[1]];
 450         }
 451         if (unlikely((pt >> 32 & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
 452                         RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
 453                 i8.u32[2] = i8.u32[2] +
 454                         (uint8_t)tbl[2] * RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
 455                 tbl[2] = *(const uint16_t *)&lpm->tbl8[i8.u32[2]];
 456         }
 457         if (unlikely((pt >> 48 & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
 458                         RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
 459                 i8.u32[3] = i8.u32[3] +
 460                         (uint8_t)tbl[3] * RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
 461                 tbl[3] = *(const uint16_t *)&lpm->tbl8[i8.u32[3]];
 462         }
 463
 464         hop[0] = (tbl[0] & RTE_LPM_LOOKUP_SUCCESS) ? (uint8_t)tbl[0] : defv;
 465         hop[1] = (tbl[1] & RTE_LPM_LOOKUP_SUCCESS) ? (uint8_t)tbl[1] : defv;
 466         hop[2] = (tbl[2] & RTE_LPM_LOOKUP_SUCCESS) ? (uint8_t)tbl[2] : defv;
 467         hop[3] = (tbl[3] & RTE_LPM_LOOKUP_SUCCESS) ? (uint8_t)tbl[3] : defv;
 468 }
 469
 470 #ifdef __cplusplus
 471 }
 472 #endif
 473
 474 #endif /* _RTE_LPM_H_ */