1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
10 * RTE Longest Prefix Match (LPM)
14 #include <sys/queue.h>
17 #include <rte_branch_prediction.h>
18 #include <rte_byteorder.h>
19 #include <rte_memory.h>
20 #include <rte_common.h>
22 #include <rte_compat.h>
28 /** Max number of characters in LPM name. */
29 #define RTE_LPM_NAMESIZE 32
31 /** Maximum depth value possible for IPv4 LPM. */
32 #define RTE_LPM_MAX_DEPTH 32
34 /** @internal Total number of tbl24 entries. */
35 #define RTE_LPM_TBL24_NUM_ENTRIES (1 << 24)
37 /** @internal Number of entries in a tbl8 group. */
38 #define RTE_LPM_TBL8_GROUP_NUM_ENTRIES 256
40 /** @internal Max number of tbl8 groups in the tbl8. */
41 #define RTE_LPM_MAX_TBL8_NUM_GROUPS (1 << 24)
43 /** @internal Total number of tbl8 groups in the tbl8. */
44 #define RTE_LPM_TBL8_NUM_GROUPS 256
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)
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); \
56 #define RTE_LPM_RETURN_IF_TRUE(cond, retval)
59 /** @internal bitmask with valid and valid_group fields set */
60 #define RTE_LPM_VALID_EXT_ENTRY_BITMASK 0x03000000
62 /** Bitmask used to indicate successful lookup */
63 #define RTE_LPM_LOOKUP_SUCCESS 0x01000000
65 #if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
66 /** @internal Tbl24 entry structure. */
68 struct rte_lpm_tbl_entry_v20 {
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
79 /* Using single uint8_t to store 3 values. */
80 uint8_t valid :1; /**< Validation flag. */
83 * - valid_group == 0: entry stores a next hop
84 * - valid_group == 1: entry stores a group_index pointing to a tbl8
86 * - valid_group indicates whether the current tbl8 is in use or not
88 uint8_t valid_group :1;
89 uint8_t depth :6; /**< Rule depth. */
93 struct rte_lpm_tbl_entry {
95 * Stores Next hop (tbl8 or tbl24 when valid_group is not set) or
96 * a group index pointing to a tbl8 structure (tbl24 only, when
99 uint32_t next_hop :24;
100 /* Using single uint8_t to store 3 values. */
101 uint32_t valid :1; /**< Validation flag. */
104 * - valid_group == 0: entry stores a next hop
105 * - valid_group == 1: entry stores a group_index pointing to a tbl8
107 * - valid_group indicates whether the current tbl8 is in use or not
109 uint32_t valid_group :1;
110 uint32_t depth :6; /**< Rule depth. */
115 struct rte_lpm_tbl_entry_v20 {
117 uint8_t valid_group :1;
126 struct rte_lpm_tbl_entry {
128 uint32_t valid_group :1;
130 uint32_t next_hop :24;
136 /** LPM configuration structure. */
137 struct rte_lpm_config {
138 uint32_t max_rules; /**< Max number of rules. */
139 uint32_t number_tbl8s; /**< Number of tbl8s to allocate. */
140 int flags; /**< This field is currently unused. */
143 /** @internal Rule structure. */
144 struct rte_lpm_rule_v20 {
145 uint32_t ip; /**< Rule IP address. */
146 uint8_t next_hop; /**< Rule next hop. */
149 struct rte_lpm_rule {
150 uint32_t ip; /**< Rule IP address. */
151 uint32_t next_hop; /**< Rule next hop. */
154 /** @internal Contains metadata about the rules table. */
155 struct rte_lpm_rule_info {
156 uint32_t used_rules; /**< Used rules so far. */
157 uint32_t first_rule; /**< Indexes the first rule of a given depth. */
160 /** @internal LPM structure. */
163 char name[RTE_LPM_NAMESIZE]; /**< Name of the lpm. */
164 uint32_t max_rules; /**< Max. balanced rules per lpm. */
165 struct rte_lpm_rule_info rule_info[RTE_LPM_MAX_DEPTH]; /**< Rule info table. */
168 struct rte_lpm_tbl_entry_v20 tbl24[RTE_LPM_TBL24_NUM_ENTRIES]
169 __rte_cache_aligned; /**< LPM tbl24 table. */
170 struct rte_lpm_tbl_entry_v20 tbl8[RTE_LPM_TBL8_NUM_ENTRIES]
171 __rte_cache_aligned; /**< LPM tbl8 table. */
172 struct rte_lpm_rule_v20 rules_tbl[]
173 __rte_cache_aligned; /**< LPM rules. */
178 char name[RTE_LPM_NAMESIZE]; /**< Name of the lpm. */
179 uint32_t max_rules; /**< Max. balanced rules per lpm. */
180 uint32_t number_tbl8s; /**< Number of tbl8s. */
181 struct rte_lpm_rule_info rule_info[RTE_LPM_MAX_DEPTH]; /**< Rule info table. */
184 struct rte_lpm_tbl_entry tbl24[RTE_LPM_TBL24_NUM_ENTRIES]
185 __rte_cache_aligned; /**< LPM tbl24 table. */
186 struct rte_lpm_tbl_entry *tbl8; /**< LPM tbl8 table. */
187 struct rte_lpm_rule *rules_tbl; /**< LPM rules. */
191 * Create an LPM object.
196 * NUMA socket ID for LPM table memory allocation
198 * Structure containing the configuration
200 * Handle to LPM object on success, NULL otherwise with rte_errno set
201 * to an appropriate values. Possible rte_errno values include:
202 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
203 * - E_RTE_SECONDARY - function was called from a secondary process instance
204 * - EINVAL - invalid parameter passed to function
205 * - ENOSPC - the maximum number of memzones has already been allocated
206 * - EEXIST - a memzone with the same name already exists
207 * - ENOMEM - no appropriate memory area found in which to create memzone
210 rte_lpm_create(const char *name, int socket_id,
211 const struct rte_lpm_config *config);
213 rte_lpm_create_v20(const char *name, int socket_id, int max_rules, int flags);
215 rte_lpm_create_v1604(const char *name, int socket_id,
216 const struct rte_lpm_config *config);
219 * Find an existing LPM object and return a pointer to it.
222 * Name of the lpm object as passed to rte_lpm_create()
224 * Pointer to lpm object or NULL if object not found with rte_errno
225 * set appropriately. Possible rte_errno values include:
226 * - ENOENT - required entry not available to return.
229 rte_lpm_find_existing(const char *name);
231 rte_lpm_find_existing_v20(const char *name);
233 rte_lpm_find_existing_v1604(const char *name);
236 * Free an LPM object.
244 rte_lpm_free(struct rte_lpm *lpm);
246 rte_lpm_free_v20(struct rte_lpm_v20 *lpm);
248 rte_lpm_free_v1604(struct rte_lpm *lpm);
251 * Add a rule to the LPM table.
256 * IP of the rule to be added to the LPM table
258 * Depth of the rule to be added to the LPM table
260 * Next hop of the rule to be added to the LPM table
262 * 0 on success, negative value otherwise
265 rte_lpm_add(struct rte_lpm *lpm, uint32_t ip, uint8_t depth, uint32_t next_hop);
267 rte_lpm_add_v20(struct rte_lpm_v20 *lpm, uint32_t ip, uint8_t depth,
270 rte_lpm_add_v1604(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
274 * Check if a rule is present in the LPM table,
275 * and provide its next hop if it is.
280 * IP of the rule to be searched
282 * Depth of the rule to searched
284 * Next hop of the rule (valid only if it is found)
286 * 1 if the rule exists, 0 if it does not, a negative value on failure
289 rte_lpm_is_rule_present(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
292 rte_lpm_is_rule_present_v20(struct rte_lpm_v20 *lpm, uint32_t ip, uint8_t depth,
295 rte_lpm_is_rule_present_v1604(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
299 * Delete a rule from the LPM table.
304 * IP of the rule to be deleted from the LPM table
306 * Depth of the rule to be deleted from the LPM table
308 * 0 on success, negative value otherwise
311 rte_lpm_delete(struct rte_lpm *lpm, uint32_t ip, uint8_t depth);
313 rte_lpm_delete_v20(struct rte_lpm_v20 *lpm, uint32_t ip, uint8_t depth);
315 rte_lpm_delete_v1604(struct rte_lpm *lpm, uint32_t ip, uint8_t depth);
318 * Delete all rules from the LPM table.
324 rte_lpm_delete_all(struct rte_lpm *lpm);
326 rte_lpm_delete_all_v20(struct rte_lpm_v20 *lpm);
328 rte_lpm_delete_all_v1604(struct rte_lpm *lpm);
331 * Lookup an IP into the LPM table.
336 * IP to be looked up in the LPM table
338 * Next hop of the most specific rule found for IP (valid on lookup hit only)
340 * -EINVAL for incorrect arguments, -ENOENT on lookup miss, 0 on lookup hit
343 rte_lpm_lookup(struct rte_lpm *lpm, uint32_t ip, uint32_t *next_hop)
345 unsigned tbl24_index = (ip >> 8);
347 const uint32_t *ptbl;
349 /* DEBUG: Check user input arguments. */
350 RTE_LPM_RETURN_IF_TRUE(((lpm == NULL) || (next_hop == NULL)), -EINVAL);
352 /* Copy tbl24 entry */
353 ptbl = (const uint32_t *)(&lpm->tbl24[tbl24_index]);
356 /* Copy tbl8 entry (only if needed) */
357 if (unlikely((tbl_entry & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
358 RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
360 unsigned tbl8_index = (uint8_t)ip +
361 (((uint32_t)tbl_entry & 0x00FFFFFF) *
362 RTE_LPM_TBL8_GROUP_NUM_ENTRIES);
364 ptbl = (const uint32_t *)&lpm->tbl8[tbl8_index];
368 *next_hop = ((uint32_t)tbl_entry & 0x00FFFFFF);
369 return (tbl_entry & RTE_LPM_LOOKUP_SUCCESS) ? 0 : -ENOENT;
373 * Lookup multiple IP addresses in an LPM table. This may be implemented as a
374 * macro, so the address of the function should not be used.
379 * Array of IPs to be looked up in the LPM table
381 * Next hop of the most specific rule found for IP (valid on lookup hit only).
382 * This is an array of two byte values. The most significant byte in each
383 * value says whether the lookup was successful (bitmask
384 * RTE_LPM_LOOKUP_SUCCESS is set). The least significant byte is the
387 * Number of elements in ips (and next_hops) array to lookup. This should be a
388 * compile time constant, and divisible by 8 for best performance.
390 * -EINVAL for incorrect arguments, otherwise 0
392 #define rte_lpm_lookup_bulk(lpm, ips, next_hops, n) \
393 rte_lpm_lookup_bulk_func(lpm, ips, next_hops, n)
396 rte_lpm_lookup_bulk_func(const struct rte_lpm *lpm, const uint32_t *ips,
397 uint32_t *next_hops, const unsigned n)
400 unsigned tbl24_indexes[n];
401 const uint32_t *ptbl;
403 /* DEBUG: Check user input arguments. */
404 RTE_LPM_RETURN_IF_TRUE(((lpm == NULL) || (ips == NULL) ||
405 (next_hops == NULL)), -EINVAL);
407 for (i = 0; i < n; i++) {
408 tbl24_indexes[i] = ips[i] >> 8;
411 for (i = 0; i < n; i++) {
412 /* Simply copy tbl24 entry to output */
413 ptbl = (const uint32_t *)&lpm->tbl24[tbl24_indexes[i]];
414 next_hops[i] = *ptbl;
416 /* Overwrite output with tbl8 entry if needed */
417 if (unlikely((next_hops[i] & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
418 RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
420 unsigned tbl8_index = (uint8_t)ips[i] +
421 (((uint32_t)next_hops[i] & 0x00FFFFFF) *
422 RTE_LPM_TBL8_GROUP_NUM_ENTRIES);
424 ptbl = (const uint32_t *)&lpm->tbl8[tbl8_index];
425 next_hops[i] = *ptbl;
431 /* Mask four results. */
432 #define RTE_LPM_MASKX4_RES UINT64_C(0x00ffffff00ffffff)
435 * Lookup four IP addresses in an LPM table.
440 * Four IPs to be looked up in the LPM table
442 * Next hop of the most specific rule found for IP (valid on lookup hit only).
443 * This is an 4 elements array of two byte values.
444 * If the lookup was succesfull for the given IP, then least significant byte
445 * of the corresponding element is the actual next hop and the most
446 * significant byte is zero.
447 * If the lookup for the given IP failed, then corresponding element would
448 * contain default value, see description of then next parameter.
450 * Default value to populate into corresponding element of hop[] array,
451 * if lookup would fail.
454 rte_lpm_lookupx4(const struct rte_lpm *lpm, xmm_t ip, uint32_t hop[4],
457 #if defined(RTE_ARCH_ARM) || defined(RTE_ARCH_ARM64)
458 #include "rte_lpm_neon.h"
459 #elif defined(RTE_ARCH_PPC_64)
460 #include "rte_lpm_altivec.h"
462 #include "rte_lpm_sse.h"
469 #endif /* _RTE_LPM_H_ */