4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
40 #include <sys/queue.h>
43 #include <rte_branch_prediction.h>
44 #include <rte_common.h>
45 #include <rte_memory.h> /* for definition of RTE_CACHE_LINE_SIZE */
46 #include <rte_malloc.h>
47 #include <rte_memzone.h>
49 #include <rte_eal_memconfig.h>
50 #include <rte_per_lcore.h>
51 #include <rte_string_fns.h>
52 #include <rte_errno.h>
53 #include <rte_rwlock.h>
54 #include <rte_spinlock.h>
58 TAILQ_HEAD(rte_lpm_list, rte_tailq_entry);
60 static struct rte_tailq_elem rte_lpm_tailq = {
63 EAL_REGISTER_TAILQ(rte_lpm_tailq)
65 #define MAX_DEPTH_TBL24 24
72 /* Macro to enable/disable run-time checks. */
73 #if defined(RTE_LIBRTE_LPM_DEBUG)
74 #include <rte_debug.h>
75 #define VERIFY_DEPTH(depth) do { \
76 if ((depth == 0) || (depth > RTE_LPM_MAX_DEPTH)) \
77 rte_panic("LPM: Invalid depth (%u) at line %d", \
78 (unsigned)(depth), __LINE__); \
81 #define VERIFY_DEPTH(depth)
85 * Converts a given depth value to its corresponding mask value.
87 * depth (IN) : range = 1 - 32
88 * mask (OUT) : 32bit mask
90 static uint32_t __attribute__((pure))
91 depth_to_mask(uint8_t depth)
95 /* To calculate a mask start with a 1 on the left hand side and right
96 * shift while populating the left hand side with 1's
98 return (int)0x80000000 >> (depth - 1);
102 * Converts given depth value to its corresponding range value.
104 static inline uint32_t __attribute__((pure))
105 depth_to_range(uint8_t depth)
110 * Calculate tbl24 range. (Note: 2^depth = 1 << depth)
112 if (depth <= MAX_DEPTH_TBL24)
113 return 1 << (MAX_DEPTH_TBL24 - depth);
115 /* Else if depth is greater than 24 */
116 return 1 << (RTE_LPM_MAX_DEPTH - depth);
120 * Find an existing lpm table and return a pointer to it.
123 rte_lpm_find_existing_v20(const char *name)
125 struct rte_lpm_v20 *l = NULL;
126 struct rte_tailq_entry *te;
127 struct rte_lpm_list *lpm_list;
129 lpm_list = RTE_TAILQ_CAST(rte_lpm_tailq.head, rte_lpm_list);
131 rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
132 TAILQ_FOREACH(te, lpm_list, next) {
133 l = (struct rte_lpm_v20 *) te->data;
134 if (strncmp(name, l->name, RTE_LPM_NAMESIZE) == 0)
137 rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
146 VERSION_SYMBOL(rte_lpm_find_existing, _v20, 2.0);
149 rte_lpm_find_existing_v1604(const char *name)
151 struct rte_lpm *l = NULL;
152 struct rte_tailq_entry *te;
153 struct rte_lpm_list *lpm_list;
155 lpm_list = RTE_TAILQ_CAST(rte_lpm_tailq.head, rte_lpm_list);
157 rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
158 TAILQ_FOREACH(te, lpm_list, next) {
159 l = (struct rte_lpm *) te->data;
160 if (strncmp(name, l->name, RTE_LPM_NAMESIZE) == 0)
163 rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
172 BIND_DEFAULT_SYMBOL(rte_lpm_find_existing, _v1604, 16.04);
173 MAP_STATIC_SYMBOL(struct rte_lpm *rte_lpm_find_existing(const char *name),
174 rte_lpm_find_existing_v1604);
177 * Allocates memory for LPM object
180 rte_lpm_create_v20(const char *name, int socket_id, int max_rules,
181 __rte_unused int flags)
183 char mem_name[RTE_LPM_NAMESIZE];
184 struct rte_lpm_v20 *lpm = NULL;
185 struct rte_tailq_entry *te;
187 struct rte_lpm_list *lpm_list;
189 lpm_list = RTE_TAILQ_CAST(rte_lpm_tailq.head, rte_lpm_list);
191 RTE_BUILD_BUG_ON(sizeof(struct rte_lpm_tbl_entry_v20) != 2);
193 /* Check user arguments. */
194 if ((name == NULL) || (socket_id < -1) || (max_rules == 0)) {
199 snprintf(mem_name, sizeof(mem_name), "LPM_%s", name);
201 /* Determine the amount of memory to allocate. */
202 mem_size = sizeof(*lpm) + (sizeof(lpm->rules_tbl[0]) * max_rules);
204 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
206 /* guarantee there's no existing */
207 TAILQ_FOREACH(te, lpm_list, next) {
208 lpm = (struct rte_lpm_v20 *) te->data;
209 if (strncmp(name, lpm->name, RTE_LPM_NAMESIZE) == 0)
215 /* allocate tailq entry */
216 te = rte_zmalloc("LPM_TAILQ_ENTRY", sizeof(*te), 0);
218 RTE_LOG(ERR, LPM, "Failed to allocate tailq entry\n");
222 /* Allocate memory to store the LPM data structures. */
223 lpm = (struct rte_lpm_v20 *)rte_zmalloc_socket(mem_name, mem_size,
224 RTE_CACHE_LINE_SIZE, socket_id);
226 RTE_LOG(ERR, LPM, "LPM memory allocation failed\n");
231 /* Save user arguments. */
232 lpm->max_rules = max_rules;
233 snprintf(lpm->name, sizeof(lpm->name), "%s", name);
235 te->data = (void *) lpm;
237 TAILQ_INSERT_TAIL(lpm_list, te, next);
240 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
244 VERSION_SYMBOL(rte_lpm_create, _v20, 2.0);
247 rte_lpm_create_v1604(const char *name, int socket_id,
248 const struct rte_lpm_config *config)
250 char mem_name[RTE_LPM_NAMESIZE];
251 struct rte_lpm *lpm = NULL;
252 struct rte_tailq_entry *te;
253 uint32_t mem_size, rules_size, tbl8s_size;
254 struct rte_lpm_list *lpm_list;
256 lpm_list = RTE_TAILQ_CAST(rte_lpm_tailq.head, rte_lpm_list);
258 RTE_BUILD_BUG_ON(sizeof(struct rte_lpm_tbl_entry) != 4);
260 /* Check user arguments. */
261 if ((name == NULL) || (socket_id < -1) || (config->max_rules == 0)
262 || config->number_tbl8s > RTE_LPM_MAX_TBL8_NUM_GROUPS) {
267 snprintf(mem_name, sizeof(mem_name), "LPM_%s", name);
269 /* Determine the amount of memory to allocate. */
270 mem_size = sizeof(*lpm);
271 rules_size = sizeof(struct rte_lpm_rule) * config->max_rules;
272 tbl8s_size = (sizeof(struct rte_lpm_tbl_entry) *
273 RTE_LPM_TBL8_GROUP_NUM_ENTRIES * config->number_tbl8s);
275 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
277 /* guarantee there's no existing */
278 TAILQ_FOREACH(te, lpm_list, next) {
279 lpm = (struct rte_lpm *) te->data;
280 if (strncmp(name, lpm->name, RTE_LPM_NAMESIZE) == 0)
286 /* allocate tailq entry */
287 te = rte_zmalloc("LPM_TAILQ_ENTRY", sizeof(*te), 0);
289 RTE_LOG(ERR, LPM, "Failed to allocate tailq entry\n");
293 /* Allocate memory to store the LPM data structures. */
294 lpm = (struct rte_lpm *)rte_zmalloc_socket(mem_name, mem_size,
295 RTE_CACHE_LINE_SIZE, socket_id);
297 RTE_LOG(ERR, LPM, "LPM memory allocation failed\n");
302 lpm->rules_tbl = (struct rte_lpm_rule *)rte_zmalloc_socket(NULL,
303 (size_t)rules_size, RTE_CACHE_LINE_SIZE, socket_id);
305 if (lpm->rules_tbl == NULL) {
306 RTE_LOG(ERR, LPM, "LPM memory allocation failed\n");
312 lpm->tbl8 = (struct rte_lpm_tbl_entry *)rte_zmalloc_socket(NULL,
313 (size_t)tbl8s_size, RTE_CACHE_LINE_SIZE, socket_id);
315 if (lpm->tbl8 == NULL) {
316 RTE_LOG(ERR, LPM, "LPM memory allocation failed\n");
322 /* Save user arguments. */
323 lpm->max_rules = config->max_rules;
324 lpm->number_tbl8s = config->number_tbl8s;
325 snprintf(lpm->name, sizeof(lpm->name), "%s", name);
327 te->data = (void *) lpm;
329 TAILQ_INSERT_TAIL(lpm_list, te, next);
332 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
336 BIND_DEFAULT_SYMBOL(rte_lpm_create, _v1604, 16.04);
338 struct rte_lpm *rte_lpm_create(const char *name, int socket_id,
339 const struct rte_lpm_config *config), rte_lpm_create_v1604);
342 * Deallocates memory for given LPM table.
345 rte_lpm_free_v20(struct rte_lpm_v20 *lpm)
347 struct rte_lpm_list *lpm_list;
348 struct rte_tailq_entry *te;
350 /* Check user arguments. */
354 lpm_list = RTE_TAILQ_CAST(rte_lpm_tailq.head, rte_lpm_list);
356 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
358 /* find our tailq entry */
359 TAILQ_FOREACH(te, lpm_list, next) {
360 if (te->data == (void *) lpm)
364 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
368 TAILQ_REMOVE(lpm_list, te, next);
370 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
375 VERSION_SYMBOL(rte_lpm_free, _v20, 2.0);
378 rte_lpm_free_v1604(struct rte_lpm *lpm)
380 struct rte_lpm_list *lpm_list;
381 struct rte_tailq_entry *te;
383 /* Check user arguments. */
387 lpm_list = RTE_TAILQ_CAST(rte_lpm_tailq.head, rte_lpm_list);
389 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
391 /* find our tailq entry */
392 TAILQ_FOREACH(te, lpm_list, next) {
393 if (te->data == (void *) lpm)
397 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
401 TAILQ_REMOVE(lpm_list, te, next);
403 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
408 BIND_DEFAULT_SYMBOL(rte_lpm_free, _v1604, 16.04);
409 MAP_STATIC_SYMBOL(void rte_lpm_free(struct rte_lpm *lpm),
413 * Adds a rule to the rule table.
415 * NOTE: The rule table is split into 32 groups. Each group contains rules that
416 * apply to a specific prefix depth (i.e. group 1 contains rules that apply to
417 * prefixes with a depth of 1 etc.). In the following code (depth - 1) is used
418 * to refer to depth 1 because even though the depth range is 1 - 32, depths
419 * are stored in the rule table from 0 - 31.
420 * NOTE: Valid range for depth parameter is 1 .. 32 inclusive.
422 static inline int32_t
423 rule_add_v20(struct rte_lpm_v20 *lpm, uint32_t ip_masked, uint8_t depth,
426 uint32_t rule_gindex, rule_index, last_rule;
431 /* Scan through rule group to see if rule already exists. */
432 if (lpm->rule_info[depth - 1].used_rules > 0) {
434 /* rule_gindex stands for rule group index. */
435 rule_gindex = lpm->rule_info[depth - 1].first_rule;
436 /* Initialise rule_index to point to start of rule group. */
437 rule_index = rule_gindex;
438 /* Last rule = Last used rule in this rule group. */
439 last_rule = rule_gindex + lpm->rule_info[depth - 1].used_rules;
441 for (; rule_index < last_rule; rule_index++) {
443 /* If rule already exists update its next_hop and return. */
444 if (lpm->rules_tbl[rule_index].ip == ip_masked) {
445 lpm->rules_tbl[rule_index].next_hop = next_hop;
451 if (rule_index == lpm->max_rules)
454 /* Calculate the position in which the rule will be stored. */
457 for (i = depth - 1; i > 0; i--) {
458 if (lpm->rule_info[i - 1].used_rules > 0) {
459 rule_index = lpm->rule_info[i - 1].first_rule
460 + lpm->rule_info[i - 1].used_rules;
464 if (rule_index == lpm->max_rules)
467 lpm->rule_info[depth - 1].first_rule = rule_index;
470 /* Make room for the new rule in the array. */
471 for (i = RTE_LPM_MAX_DEPTH; i > depth; i--) {
472 if (lpm->rule_info[i - 1].first_rule
473 + lpm->rule_info[i - 1].used_rules == lpm->max_rules)
476 if (lpm->rule_info[i - 1].used_rules > 0) {
477 lpm->rules_tbl[lpm->rule_info[i - 1].first_rule
478 + lpm->rule_info[i - 1].used_rules]
479 = lpm->rules_tbl[lpm->rule_info[i - 1].first_rule];
480 lpm->rule_info[i - 1].first_rule++;
484 /* Add the new rule. */
485 lpm->rules_tbl[rule_index].ip = ip_masked;
486 lpm->rules_tbl[rule_index].next_hop = next_hop;
488 /* Increment the used rules counter for this rule group. */
489 lpm->rule_info[depth - 1].used_rules++;
494 static inline int32_t
495 rule_add_v1604(struct rte_lpm *lpm, uint32_t ip_masked, uint8_t depth,
498 uint32_t rule_gindex, rule_index, last_rule;
503 /* Scan through rule group to see if rule already exists. */
504 if (lpm->rule_info[depth - 1].used_rules > 0) {
506 /* rule_gindex stands for rule group index. */
507 rule_gindex = lpm->rule_info[depth - 1].first_rule;
508 /* Initialise rule_index to point to start of rule group. */
509 rule_index = rule_gindex;
510 /* Last rule = Last used rule in this rule group. */
511 last_rule = rule_gindex + lpm->rule_info[depth - 1].used_rules;
513 for (; rule_index < last_rule; rule_index++) {
515 /* If rule already exists update its next_hop and return. */
516 if (lpm->rules_tbl[rule_index].ip == ip_masked) {
517 lpm->rules_tbl[rule_index].next_hop = next_hop;
523 if (rule_index == lpm->max_rules)
526 /* Calculate the position in which the rule will be stored. */
529 for (i = depth - 1; i > 0; i--) {
530 if (lpm->rule_info[i - 1].used_rules > 0) {
531 rule_index = lpm->rule_info[i - 1].first_rule
532 + lpm->rule_info[i - 1].used_rules;
536 if (rule_index == lpm->max_rules)
539 lpm->rule_info[depth - 1].first_rule = rule_index;
542 /* Make room for the new rule in the array. */
543 for (i = RTE_LPM_MAX_DEPTH; i > depth; i--) {
544 if (lpm->rule_info[i - 1].first_rule
545 + lpm->rule_info[i - 1].used_rules == lpm->max_rules)
548 if (lpm->rule_info[i - 1].used_rules > 0) {
549 lpm->rules_tbl[lpm->rule_info[i - 1].first_rule
550 + lpm->rule_info[i - 1].used_rules]
551 = lpm->rules_tbl[lpm->rule_info[i - 1].first_rule];
552 lpm->rule_info[i - 1].first_rule++;
556 /* Add the new rule. */
557 lpm->rules_tbl[rule_index].ip = ip_masked;
558 lpm->rules_tbl[rule_index].next_hop = next_hop;
560 /* Increment the used rules counter for this rule group. */
561 lpm->rule_info[depth - 1].used_rules++;
567 * Delete a rule from the rule table.
568 * NOTE: Valid range for depth parameter is 1 .. 32 inclusive.
571 rule_delete_v20(struct rte_lpm_v20 *lpm, int32_t rule_index, uint8_t depth)
577 lpm->rules_tbl[rule_index] =
578 lpm->rules_tbl[lpm->rule_info[depth - 1].first_rule
579 + lpm->rule_info[depth - 1].used_rules - 1];
581 for (i = depth; i < RTE_LPM_MAX_DEPTH; i++) {
582 if (lpm->rule_info[i].used_rules > 0) {
583 lpm->rules_tbl[lpm->rule_info[i].first_rule - 1] =
584 lpm->rules_tbl[lpm->rule_info[i].first_rule
585 + lpm->rule_info[i].used_rules - 1];
586 lpm->rule_info[i].first_rule--;
590 lpm->rule_info[depth - 1].used_rules--;
594 rule_delete_v1604(struct rte_lpm *lpm, int32_t rule_index, uint8_t depth)
600 lpm->rules_tbl[rule_index] =
601 lpm->rules_tbl[lpm->rule_info[depth - 1].first_rule
602 + lpm->rule_info[depth - 1].used_rules - 1];
604 for (i = depth; i < RTE_LPM_MAX_DEPTH; i++) {
605 if (lpm->rule_info[i].used_rules > 0) {
606 lpm->rules_tbl[lpm->rule_info[i].first_rule - 1] =
607 lpm->rules_tbl[lpm->rule_info[i].first_rule
608 + lpm->rule_info[i].used_rules - 1];
609 lpm->rule_info[i].first_rule--;
613 lpm->rule_info[depth - 1].used_rules--;
617 * Finds a rule in rule table.
618 * NOTE: Valid range for depth parameter is 1 .. 32 inclusive.
620 static inline int32_t
621 rule_find_v20(struct rte_lpm_v20 *lpm, uint32_t ip_masked, uint8_t depth)
623 uint32_t rule_gindex, last_rule, rule_index;
627 rule_gindex = lpm->rule_info[depth - 1].first_rule;
628 last_rule = rule_gindex + lpm->rule_info[depth - 1].used_rules;
630 /* Scan used rules at given depth to find rule. */
631 for (rule_index = rule_gindex; rule_index < last_rule; rule_index++) {
632 /* If rule is found return the rule index. */
633 if (lpm->rules_tbl[rule_index].ip == ip_masked)
637 /* If rule is not found return -EINVAL. */
641 static inline int32_t
642 rule_find_v1604(struct rte_lpm *lpm, uint32_t ip_masked, uint8_t depth)
644 uint32_t rule_gindex, last_rule, rule_index;
648 rule_gindex = lpm->rule_info[depth - 1].first_rule;
649 last_rule = rule_gindex + lpm->rule_info[depth - 1].used_rules;
651 /* Scan used rules at given depth to find rule. */
652 for (rule_index = rule_gindex; rule_index < last_rule; rule_index++) {
653 /* If rule is found return the rule index. */
654 if (lpm->rules_tbl[rule_index].ip == ip_masked)
658 /* If rule is not found return -EINVAL. */
663 * Find, clean and allocate a tbl8.
665 static inline int32_t
666 tbl8_alloc_v20(struct rte_lpm_tbl_entry_v20 *tbl8)
668 uint32_t group_idx; /* tbl8 group index. */
669 struct rte_lpm_tbl_entry_v20 *tbl8_entry;
671 /* Scan through tbl8 to find a free (i.e. INVALID) tbl8 group. */
672 for (group_idx = 0; group_idx < RTE_LPM_TBL8_NUM_GROUPS;
674 tbl8_entry = &tbl8[group_idx * RTE_LPM_TBL8_GROUP_NUM_ENTRIES];
675 /* If a free tbl8 group is found clean it and set as VALID. */
676 if (!tbl8_entry->valid_group) {
677 memset(&tbl8_entry[0], 0,
678 RTE_LPM_TBL8_GROUP_NUM_ENTRIES *
679 sizeof(tbl8_entry[0]));
681 tbl8_entry->valid_group = VALID;
683 /* Return group index for allocated tbl8 group. */
688 /* If there are no tbl8 groups free then return error. */
692 static inline int32_t
693 tbl8_alloc_v1604(struct rte_lpm_tbl_entry *tbl8, uint32_t number_tbl8s)
695 uint32_t group_idx; /* tbl8 group index. */
696 struct rte_lpm_tbl_entry *tbl8_entry;
698 /* Scan through tbl8 to find a free (i.e. INVALID) tbl8 group. */
699 for (group_idx = 0; group_idx < number_tbl8s; group_idx++) {
700 tbl8_entry = &tbl8[group_idx * RTE_LPM_TBL8_GROUP_NUM_ENTRIES];
701 /* If a free tbl8 group is found clean it and set as VALID. */
702 if (!tbl8_entry->valid_group) {
703 memset(&tbl8_entry[0], 0,
704 RTE_LPM_TBL8_GROUP_NUM_ENTRIES *
705 sizeof(tbl8_entry[0]));
707 tbl8_entry->valid_group = VALID;
709 /* Return group index for allocated tbl8 group. */
714 /* If there are no tbl8 groups free then return error. */
719 tbl8_free_v20(struct rte_lpm_tbl_entry_v20 *tbl8, uint32_t tbl8_group_start)
721 /* Set tbl8 group invalid*/
722 tbl8[tbl8_group_start].valid_group = INVALID;
726 tbl8_free_v1604(struct rte_lpm_tbl_entry *tbl8, uint32_t tbl8_group_start)
728 /* Set tbl8 group invalid*/
729 tbl8[tbl8_group_start].valid_group = INVALID;
732 static inline int32_t
733 add_depth_small_v20(struct rte_lpm_v20 *lpm, uint32_t ip, uint8_t depth,
736 uint32_t tbl24_index, tbl24_range, tbl8_index, tbl8_group_end, i, j;
738 /* Calculate the index into Table24. */
739 tbl24_index = ip >> 8;
740 tbl24_range = depth_to_range(depth);
742 for (i = tbl24_index; i < (tbl24_index + tbl24_range); i++) {
744 * For invalid OR valid and non-extended tbl 24 entries set
747 if (!lpm->tbl24[i].valid || (lpm->tbl24[i].valid_group == 0 &&
748 lpm->tbl24[i].depth <= depth)) {
750 struct rte_lpm_tbl_entry_v20 new_tbl24_entry = {
751 { .next_hop = next_hop, },
757 /* Setting tbl24 entry in one go to avoid race
760 lpm->tbl24[i] = new_tbl24_entry;
765 if (lpm->tbl24[i].valid_group == 1) {
766 /* If tbl24 entry is valid and extended calculate the
769 tbl8_index = lpm->tbl24[i].group_idx *
770 RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
771 tbl8_group_end = tbl8_index +
772 RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
774 for (j = tbl8_index; j < tbl8_group_end; j++) {
775 if (!lpm->tbl8[j].valid ||
776 lpm->tbl8[j].depth <= depth) {
777 struct rte_lpm_tbl_entry_v20
780 .valid_group = VALID,
782 .next_hop = next_hop,
786 * Setting tbl8 entry in one go to avoid
789 lpm->tbl8[j] = new_tbl8_entry;
800 static inline int32_t
801 add_depth_small_v1604(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
804 #define group_idx next_hop
805 uint32_t tbl24_index, tbl24_range, tbl8_index, tbl8_group_end, i, j;
807 /* Calculate the index into Table24. */
808 tbl24_index = ip >> 8;
809 tbl24_range = depth_to_range(depth);
811 for (i = tbl24_index; i < (tbl24_index + tbl24_range); i++) {
813 * For invalid OR valid and non-extended tbl 24 entries set
816 if (!lpm->tbl24[i].valid || (lpm->tbl24[i].valid_group == 0 &&
817 lpm->tbl24[i].depth <= depth)) {
819 struct rte_lpm_tbl_entry new_tbl24_entry = {
820 .next_hop = next_hop,
826 /* Setting tbl24 entry in one go to avoid race
829 lpm->tbl24[i] = new_tbl24_entry;
834 if (lpm->tbl24[i].valid_group == 1) {
835 /* If tbl24 entry is valid and extended calculate the
838 tbl8_index = lpm->tbl24[i].group_idx *
839 RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
840 tbl8_group_end = tbl8_index +
841 RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
843 for (j = tbl8_index; j < tbl8_group_end; j++) {
844 if (!lpm->tbl8[j].valid ||
845 lpm->tbl8[j].depth <= depth) {
846 struct rte_lpm_tbl_entry
849 .valid_group = VALID,
851 .next_hop = next_hop,
855 * Setting tbl8 entry in one go to avoid
858 lpm->tbl8[j] = new_tbl8_entry;
869 static inline int32_t
870 add_depth_big_v20(struct rte_lpm_v20 *lpm, uint32_t ip_masked, uint8_t depth,
873 uint32_t tbl24_index;
874 int32_t tbl8_group_index, tbl8_group_start, tbl8_group_end, tbl8_index,
877 tbl24_index = (ip_masked >> 8);
878 tbl8_range = depth_to_range(depth);
880 if (!lpm->tbl24[tbl24_index].valid) {
881 /* Search for a free tbl8 group. */
882 tbl8_group_index = tbl8_alloc_v20(lpm->tbl8);
884 /* Check tbl8 allocation was successful. */
885 if (tbl8_group_index < 0) {
886 return tbl8_group_index;
889 /* Find index into tbl8 and range. */
890 tbl8_index = (tbl8_group_index *
891 RTE_LPM_TBL8_GROUP_NUM_ENTRIES) +
894 /* Set tbl8 entry. */
895 for (i = tbl8_index; i < (tbl8_index + tbl8_range); i++) {
896 lpm->tbl8[i].depth = depth;
897 lpm->tbl8[i].next_hop = next_hop;
898 lpm->tbl8[i].valid = VALID;
902 * Update tbl24 entry to point to new tbl8 entry. Note: The
903 * ext_flag and tbl8_index need to be updated simultaneously,
904 * so assign whole structure in one go
907 struct rte_lpm_tbl_entry_v20 new_tbl24_entry = {
908 { .group_idx = (uint8_t)tbl8_group_index, },
914 lpm->tbl24[tbl24_index] = new_tbl24_entry;
916 } /* If valid entry but not extended calculate the index into Table8. */
917 else if (lpm->tbl24[tbl24_index].valid_group == 0) {
918 /* Search for free tbl8 group. */
919 tbl8_group_index = tbl8_alloc_v20(lpm->tbl8);
921 if (tbl8_group_index < 0) {
922 return tbl8_group_index;
925 tbl8_group_start = tbl8_group_index *
926 RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
927 tbl8_group_end = tbl8_group_start +
928 RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
930 /* Populate new tbl8 with tbl24 value. */
931 for (i = tbl8_group_start; i < tbl8_group_end; i++) {
932 lpm->tbl8[i].valid = VALID;
933 lpm->tbl8[i].depth = lpm->tbl24[tbl24_index].depth;
934 lpm->tbl8[i].next_hop =
935 lpm->tbl24[tbl24_index].next_hop;
938 tbl8_index = tbl8_group_start + (ip_masked & 0xFF);
940 /* Insert new rule into the tbl8 entry. */
941 for (i = tbl8_index; i < tbl8_index + tbl8_range; i++) {
942 if (!lpm->tbl8[i].valid ||
943 lpm->tbl8[i].depth <= depth) {
944 lpm->tbl8[i].valid = VALID;
945 lpm->tbl8[i].depth = depth;
946 lpm->tbl8[i].next_hop = next_hop;
953 * Update tbl24 entry to point to new tbl8 entry. Note: The
954 * ext_flag and tbl8_index need to be updated simultaneously,
955 * so assign whole structure in one go.
958 struct rte_lpm_tbl_entry_v20 new_tbl24_entry = {
959 { .group_idx = (uint8_t)tbl8_group_index, },
965 lpm->tbl24[tbl24_index] = new_tbl24_entry;
968 * If it is valid, extended entry calculate the index into tbl8.
970 tbl8_group_index = lpm->tbl24[tbl24_index].group_idx;
971 tbl8_group_start = tbl8_group_index *
972 RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
973 tbl8_index = tbl8_group_start + (ip_masked & 0xFF);
975 for (i = tbl8_index; i < (tbl8_index + tbl8_range); i++) {
977 if (!lpm->tbl8[i].valid ||
978 lpm->tbl8[i].depth <= depth) {
979 struct rte_lpm_tbl_entry_v20 new_tbl8_entry = {
982 .next_hop = next_hop,
983 .valid_group = lpm->tbl8[i].valid_group,
987 * Setting tbl8 entry in one go to avoid race
990 lpm->tbl8[i] = new_tbl8_entry;
1000 static inline int32_t
1001 add_depth_big_v1604(struct rte_lpm *lpm, uint32_t ip_masked, uint8_t depth,
1004 #define group_idx next_hop
1005 uint32_t tbl24_index;
1006 int32_t tbl8_group_index, tbl8_group_start, tbl8_group_end, tbl8_index,
1009 tbl24_index = (ip_masked >> 8);
1010 tbl8_range = depth_to_range(depth);
1012 if (!lpm->tbl24[tbl24_index].valid) {
1013 /* Search for a free tbl8 group. */
1014 tbl8_group_index = tbl8_alloc_v1604(lpm->tbl8, lpm->number_tbl8s);
1016 /* Check tbl8 allocation was successful. */
1017 if (tbl8_group_index < 0) {
1018 return tbl8_group_index;
1021 /* Find index into tbl8 and range. */
1022 tbl8_index = (tbl8_group_index *
1023 RTE_LPM_TBL8_GROUP_NUM_ENTRIES) +
1026 /* Set tbl8 entry. */
1027 for (i = tbl8_index; i < (tbl8_index + tbl8_range); i++) {
1028 lpm->tbl8[i].depth = depth;
1029 lpm->tbl8[i].next_hop = next_hop;
1030 lpm->tbl8[i].valid = VALID;
1034 * Update tbl24 entry to point to new tbl8 entry. Note: The
1035 * ext_flag and tbl8_index need to be updated simultaneously,
1036 * so assign whole structure in one go
1039 struct rte_lpm_tbl_entry new_tbl24_entry = {
1040 .group_idx = (uint8_t)tbl8_group_index,
1046 lpm->tbl24[tbl24_index] = new_tbl24_entry;
1048 } /* If valid entry but not extended calculate the index into Table8. */
1049 else if (lpm->tbl24[tbl24_index].valid_group == 0) {
1050 /* Search for free tbl8 group. */
1051 tbl8_group_index = tbl8_alloc_v1604(lpm->tbl8, lpm->number_tbl8s);
1053 if (tbl8_group_index < 0) {
1054 return tbl8_group_index;
1057 tbl8_group_start = tbl8_group_index *
1058 RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
1059 tbl8_group_end = tbl8_group_start +
1060 RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
1062 /* Populate new tbl8 with tbl24 value. */
1063 for (i = tbl8_group_start; i < tbl8_group_end; i++) {
1064 lpm->tbl8[i].valid = VALID;
1065 lpm->tbl8[i].depth = lpm->tbl24[tbl24_index].depth;
1066 lpm->tbl8[i].next_hop =
1067 lpm->tbl24[tbl24_index].next_hop;
1070 tbl8_index = tbl8_group_start + (ip_masked & 0xFF);
1072 /* Insert new rule into the tbl8 entry. */
1073 for (i = tbl8_index; i < tbl8_index + tbl8_range; i++) {
1074 if (!lpm->tbl8[i].valid ||
1075 lpm->tbl8[i].depth <= depth) {
1076 lpm->tbl8[i].valid = VALID;
1077 lpm->tbl8[i].depth = depth;
1078 lpm->tbl8[i].next_hop = next_hop;
1085 * Update tbl24 entry to point to new tbl8 entry. Note: The
1086 * ext_flag and tbl8_index need to be updated simultaneously,
1087 * so assign whole structure in one go.
1090 struct rte_lpm_tbl_entry new_tbl24_entry = {
1091 .group_idx = (uint8_t)tbl8_group_index,
1097 lpm->tbl24[tbl24_index] = new_tbl24_entry;
1100 * If it is valid, extended entry calculate the index into tbl8.
1102 tbl8_group_index = lpm->tbl24[tbl24_index].group_idx;
1103 tbl8_group_start = tbl8_group_index *
1104 RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
1105 tbl8_index = tbl8_group_start + (ip_masked & 0xFF);
1107 for (i = tbl8_index; i < (tbl8_index + tbl8_range); i++) {
1109 if (!lpm->tbl8[i].valid ||
1110 lpm->tbl8[i].depth <= depth) {
1111 struct rte_lpm_tbl_entry new_tbl8_entry = {
1114 .next_hop = next_hop,
1115 .valid_group = lpm->tbl8[i].valid_group,
1119 * Setting tbl8 entry in one go to avoid race
1122 lpm->tbl8[i] = new_tbl8_entry;
1136 rte_lpm_add_v20(struct rte_lpm_v20 *lpm, uint32_t ip, uint8_t depth,
1139 int32_t rule_index, status = 0;
1142 /* Check user arguments. */
1143 if ((lpm == NULL) || (depth < 1) || (depth > RTE_LPM_MAX_DEPTH))
1146 ip_masked = ip & depth_to_mask(depth);
1148 /* Add the rule to the rule table. */
1149 rule_index = rule_add_v20(lpm, ip_masked, depth, next_hop);
1151 /* If the is no space available for new rule return error. */
1152 if (rule_index < 0) {
1156 if (depth <= MAX_DEPTH_TBL24) {
1157 status = add_depth_small_v20(lpm, ip_masked, depth, next_hop);
1158 } else { /* If depth > RTE_LPM_MAX_DEPTH_TBL24 */
1159 status = add_depth_big_v20(lpm, ip_masked, depth, next_hop);
1162 * If add fails due to exhaustion of tbl8 extensions delete
1163 * rule that was added to rule table.
1166 rule_delete_v20(lpm, rule_index, depth);
1174 VERSION_SYMBOL(rte_lpm_add, _v20, 2.0);
1177 rte_lpm_add_v1604(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
1180 int32_t rule_index, status = 0;
1183 /* Check user arguments. */
1184 if ((lpm == NULL) || (depth < 1) || (depth > RTE_LPM_MAX_DEPTH))
1187 ip_masked = ip & depth_to_mask(depth);
1189 /* Add the rule to the rule table. */
1190 rule_index = rule_add_v1604(lpm, ip_masked, depth, next_hop);
1192 /* If the is no space available for new rule return error. */
1193 if (rule_index < 0) {
1197 if (depth <= MAX_DEPTH_TBL24) {
1198 status = add_depth_small_v1604(lpm, ip_masked, depth, next_hop);
1199 } else { /* If depth > RTE_LPM_MAX_DEPTH_TBL24 */
1200 status = add_depth_big_v1604(lpm, ip_masked, depth, next_hop);
1203 * If add fails due to exhaustion of tbl8 extensions delete
1204 * rule that was added to rule table.
1207 rule_delete_v1604(lpm, rule_index, depth);
1215 BIND_DEFAULT_SYMBOL(rte_lpm_add, _v1604, 16.04);
1216 MAP_STATIC_SYMBOL(int rte_lpm_add(struct rte_lpm *lpm, uint32_t ip,
1217 uint8_t depth, uint32_t next_hop), rte_lpm_add_v1604);
1220 * Look for a rule in the high-level rules table
1223 rte_lpm_is_rule_present_v20(struct rte_lpm_v20 *lpm, uint32_t ip, uint8_t depth,
1229 /* Check user arguments. */
1230 if ((lpm == NULL) ||
1231 (next_hop == NULL) ||
1232 (depth < 1) || (depth > RTE_LPM_MAX_DEPTH))
1235 /* Look for the rule using rule_find. */
1236 ip_masked = ip & depth_to_mask(depth);
1237 rule_index = rule_find_v20(lpm, ip_masked, depth);
1239 if (rule_index >= 0) {
1240 *next_hop = lpm->rules_tbl[rule_index].next_hop;
1244 /* If rule is not found return 0. */
1247 VERSION_SYMBOL(rte_lpm_is_rule_present, _v20, 2.0);
1250 rte_lpm_is_rule_present_v1604(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
1256 /* Check user arguments. */
1257 if ((lpm == NULL) ||
1258 (next_hop == NULL) ||
1259 (depth < 1) || (depth > RTE_LPM_MAX_DEPTH))
1262 /* Look for the rule using rule_find. */
1263 ip_masked = ip & depth_to_mask(depth);
1264 rule_index = rule_find_v1604(lpm, ip_masked, depth);
1266 if (rule_index >= 0) {
1267 *next_hop = lpm->rules_tbl[rule_index].next_hop;
1271 /* If rule is not found return 0. */
1274 BIND_DEFAULT_SYMBOL(rte_lpm_is_rule_present, _v1604, 16.04);
1275 MAP_STATIC_SYMBOL(int rte_lpm_is_rule_present(struct rte_lpm *lpm, uint32_t ip,
1276 uint8_t depth, uint32_t *next_hop), rte_lpm_is_rule_present_v1604);
1278 static inline int32_t
1279 find_previous_rule_v20(struct rte_lpm_v20 *lpm, uint32_t ip, uint8_t depth,
1280 uint8_t *sub_rule_depth)
1286 for (prev_depth = (uint8_t)(depth - 1); prev_depth > 0; prev_depth--) {
1287 ip_masked = ip & depth_to_mask(prev_depth);
1289 rule_index = rule_find_v20(lpm, ip_masked, prev_depth);
1291 if (rule_index >= 0) {
1292 *sub_rule_depth = prev_depth;
1300 static inline int32_t
1301 find_previous_rule_v1604(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
1302 uint8_t *sub_rule_depth)
1308 for (prev_depth = (uint8_t)(depth - 1); prev_depth > 0; prev_depth--) {
1309 ip_masked = ip & depth_to_mask(prev_depth);
1311 rule_index = rule_find_v1604(lpm, ip_masked, prev_depth);
1313 if (rule_index >= 0) {
1314 *sub_rule_depth = prev_depth;
1322 static inline int32_t
1323 delete_depth_small_v20(struct rte_lpm_v20 *lpm, uint32_t ip_masked,
1324 uint8_t depth, int32_t sub_rule_index, uint8_t sub_rule_depth)
1326 uint32_t tbl24_range, tbl24_index, tbl8_group_index, tbl8_index, i, j;
1328 /* Calculate the range and index into Table24. */
1329 tbl24_range = depth_to_range(depth);
1330 tbl24_index = (ip_masked >> 8);
1333 * Firstly check the sub_rule_index. A -1 indicates no replacement rule
1334 * and a positive number indicates a sub_rule_index.
1336 if (sub_rule_index < 0) {
1338 * If no replacement rule exists then invalidate entries
1339 * associated with this rule.
1341 for (i = tbl24_index; i < (tbl24_index + tbl24_range); i++) {
1343 if (lpm->tbl24[i].valid_group == 0 &&
1344 lpm->tbl24[i].depth <= depth) {
1345 lpm->tbl24[i].valid = INVALID;
1346 } else if (lpm->tbl24[i].valid_group == 1) {
1348 * If TBL24 entry is extended, then there has
1349 * to be a rule with depth >= 25 in the
1350 * associated TBL8 group.
1353 tbl8_group_index = lpm->tbl24[i].group_idx;
1354 tbl8_index = tbl8_group_index *
1355 RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
1357 for (j = tbl8_index; j < (tbl8_index +
1358 RTE_LPM_TBL8_GROUP_NUM_ENTRIES); j++) {
1360 if (lpm->tbl8[j].depth <= depth)
1361 lpm->tbl8[j].valid = INVALID;
1367 * If a replacement rule exists then modify entries
1368 * associated with this rule.
1371 struct rte_lpm_tbl_entry_v20 new_tbl24_entry = {
1372 {.next_hop = lpm->rules_tbl[sub_rule_index].next_hop,},
1375 .depth = sub_rule_depth,
1378 struct rte_lpm_tbl_entry_v20 new_tbl8_entry = {
1380 .valid_group = VALID,
1381 .depth = sub_rule_depth,
1382 .next_hop = lpm->rules_tbl
1383 [sub_rule_index].next_hop,
1386 for (i = tbl24_index; i < (tbl24_index + tbl24_range); i++) {
1388 if (lpm->tbl24[i].valid_group == 0 &&
1389 lpm->tbl24[i].depth <= depth) {
1390 lpm->tbl24[i] = new_tbl24_entry;
1391 } else if (lpm->tbl24[i].valid_group == 1) {
1393 * If TBL24 entry is extended, then there has
1394 * to be a rule with depth >= 25 in the
1395 * associated TBL8 group.
1398 tbl8_group_index = lpm->tbl24[i].group_idx;
1399 tbl8_index = tbl8_group_index *
1400 RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
1402 for (j = tbl8_index; j < (tbl8_index +
1403 RTE_LPM_TBL8_GROUP_NUM_ENTRIES); j++) {
1405 if (lpm->tbl8[j].depth <= depth)
1406 lpm->tbl8[j] = new_tbl8_entry;
1415 static inline int32_t
1416 delete_depth_small_v1604(struct rte_lpm *lpm, uint32_t ip_masked,
1417 uint8_t depth, int32_t sub_rule_index, uint8_t sub_rule_depth)
1419 #define group_idx next_hop
1420 uint32_t tbl24_range, tbl24_index, tbl8_group_index, tbl8_index, i, j;
1422 /* Calculate the range and index into Table24. */
1423 tbl24_range = depth_to_range(depth);
1424 tbl24_index = (ip_masked >> 8);
1427 * Firstly check the sub_rule_index. A -1 indicates no replacement rule
1428 * and a positive number indicates a sub_rule_index.
1430 if (sub_rule_index < 0) {
1432 * If no replacement rule exists then invalidate entries
1433 * associated with this rule.
1435 for (i = tbl24_index; i < (tbl24_index + tbl24_range); i++) {
1437 if (lpm->tbl24[i].valid_group == 0 &&
1438 lpm->tbl24[i].depth <= depth) {
1439 lpm->tbl24[i].valid = INVALID;
1440 } else if (lpm->tbl24[i].valid_group == 1) {
1442 * If TBL24 entry is extended, then there has
1443 * to be a rule with depth >= 25 in the
1444 * associated TBL8 group.
1447 tbl8_group_index = lpm->tbl24[i].group_idx;
1448 tbl8_index = tbl8_group_index *
1449 RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
1451 for (j = tbl8_index; j < (tbl8_index +
1452 RTE_LPM_TBL8_GROUP_NUM_ENTRIES); j++) {
1454 if (lpm->tbl8[j].depth <= depth)
1455 lpm->tbl8[j].valid = INVALID;
1461 * If a replacement rule exists then modify entries
1462 * associated with this rule.
1465 struct rte_lpm_tbl_entry new_tbl24_entry = {
1466 .next_hop = lpm->rules_tbl[sub_rule_index].next_hop,
1469 .depth = sub_rule_depth,
1472 struct rte_lpm_tbl_entry new_tbl8_entry = {
1474 .valid_group = VALID,
1475 .depth = sub_rule_depth,
1476 .next_hop = lpm->rules_tbl
1477 [sub_rule_index].next_hop,
1480 for (i = tbl24_index; i < (tbl24_index + tbl24_range); i++) {
1482 if (lpm->tbl24[i].valid_group == 0 &&
1483 lpm->tbl24[i].depth <= depth) {
1484 lpm->tbl24[i] = new_tbl24_entry;
1485 } else if (lpm->tbl24[i].valid_group == 1) {
1487 * If TBL24 entry is extended, then there has
1488 * to be a rule with depth >= 25 in the
1489 * associated TBL8 group.
1492 tbl8_group_index = lpm->tbl24[i].group_idx;
1493 tbl8_index = tbl8_group_index *
1494 RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
1496 for (j = tbl8_index; j < (tbl8_index +
1497 RTE_LPM_TBL8_GROUP_NUM_ENTRIES); j++) {
1499 if (lpm->tbl8[j].depth <= depth)
1500 lpm->tbl8[j] = new_tbl8_entry;
1510 * Checks if table 8 group can be recycled.
1512 * Return of -EEXIST means tbl8 is in use and thus can not be recycled.
1513 * Return of -EINVAL means tbl8 is empty and thus can be recycled
1514 * Return of value > -1 means tbl8 is in use but has all the same values and
1515 * thus can be recycled
1517 static inline int32_t
1518 tbl8_recycle_check_v20(struct rte_lpm_tbl_entry_v20 *tbl8,
1519 uint32_t tbl8_group_start)
1521 uint32_t tbl8_group_end, i;
1522 tbl8_group_end = tbl8_group_start + RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
1525 * Check the first entry of the given tbl8. If it is invalid we know
1526 * this tbl8 does not contain any rule with a depth < RTE_LPM_MAX_DEPTH
1527 * (As they would affect all entries in a tbl8) and thus this table
1528 * can not be recycled.
1530 if (tbl8[tbl8_group_start].valid) {
1532 * If first entry is valid check if the depth is less than 24
1533 * and if so check the rest of the entries to verify that they
1534 * are all of this depth.
1536 if (tbl8[tbl8_group_start].depth < MAX_DEPTH_TBL24) {
1537 for (i = (tbl8_group_start + 1); i < tbl8_group_end;
1540 if (tbl8[i].depth !=
1541 tbl8[tbl8_group_start].depth) {
1546 /* If all entries are the same return the tb8 index */
1547 return tbl8_group_start;
1553 * If the first entry is invalid check if the rest of the entries in
1554 * the tbl8 are invalid.
1556 for (i = (tbl8_group_start + 1); i < tbl8_group_end; i++) {
1560 /* If no valid entries are found then return -EINVAL. */
1564 static inline int32_t
1565 tbl8_recycle_check_v1604(struct rte_lpm_tbl_entry *tbl8,
1566 uint32_t tbl8_group_start)
1568 uint32_t tbl8_group_end, i;
1569 tbl8_group_end = tbl8_group_start + RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
1572 * Check the first entry of the given tbl8. If it is invalid we know
1573 * this tbl8 does not contain any rule with a depth < RTE_LPM_MAX_DEPTH
1574 * (As they would affect all entries in a tbl8) and thus this table
1575 * can not be recycled.
1577 if (tbl8[tbl8_group_start].valid) {
1579 * If first entry is valid check if the depth is less than 24
1580 * and if so check the rest of the entries to verify that they
1581 * are all of this depth.
1583 if (tbl8[tbl8_group_start].depth < MAX_DEPTH_TBL24) {
1584 for (i = (tbl8_group_start + 1); i < tbl8_group_end;
1587 if (tbl8[i].depth !=
1588 tbl8[tbl8_group_start].depth) {
1593 /* If all entries are the same return the tb8 index */
1594 return tbl8_group_start;
1600 * If the first entry is invalid check if the rest of the entries in
1601 * the tbl8 are invalid.
1603 for (i = (tbl8_group_start + 1); i < tbl8_group_end; i++) {
1607 /* If no valid entries are found then return -EINVAL. */
1611 static inline int32_t
1612 delete_depth_big_v20(struct rte_lpm_v20 *lpm, uint32_t ip_masked,
1613 uint8_t depth, int32_t sub_rule_index, uint8_t sub_rule_depth)
1615 uint32_t tbl24_index, tbl8_group_index, tbl8_group_start, tbl8_index,
1617 int32_t tbl8_recycle_index;
1620 * Calculate the index into tbl24 and range. Note: All depths larger
1621 * than MAX_DEPTH_TBL24 are associated with only one tbl24 entry.
1623 tbl24_index = ip_masked >> 8;
1625 /* Calculate the index into tbl8 and range. */
1626 tbl8_group_index = lpm->tbl24[tbl24_index].group_idx;
1627 tbl8_group_start = tbl8_group_index * RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
1628 tbl8_index = tbl8_group_start + (ip_masked & 0xFF);
1629 tbl8_range = depth_to_range(depth);
1631 if (sub_rule_index < 0) {
1633 * Loop through the range of entries on tbl8 for which the
1634 * rule_to_delete must be removed or modified.
1636 for (i = tbl8_index; i < (tbl8_index + tbl8_range); i++) {
1637 if (lpm->tbl8[i].depth <= depth)
1638 lpm->tbl8[i].valid = INVALID;
1641 /* Set new tbl8 entry. */
1642 struct rte_lpm_tbl_entry_v20 new_tbl8_entry = {
1644 .depth = sub_rule_depth,
1645 .valid_group = lpm->tbl8[tbl8_group_start].valid_group,
1646 .next_hop = lpm->rules_tbl[sub_rule_index].next_hop,
1650 * Loop through the range of entries on tbl8 for which the
1651 * rule_to_delete must be modified.
1653 for (i = tbl8_index; i < (tbl8_index + tbl8_range); i++) {
1654 if (lpm->tbl8[i].depth <= depth)
1655 lpm->tbl8[i] = new_tbl8_entry;
1660 * Check if there are any valid entries in this tbl8 group. If all
1661 * tbl8 entries are invalid we can free the tbl8 and invalidate the
1662 * associated tbl24 entry.
1665 tbl8_recycle_index = tbl8_recycle_check_v20(lpm->tbl8, tbl8_group_start);
1667 if (tbl8_recycle_index == -EINVAL) {
1668 /* Set tbl24 before freeing tbl8 to avoid race condition. */
1669 lpm->tbl24[tbl24_index].valid = 0;
1670 tbl8_free_v20(lpm->tbl8, tbl8_group_start);
1671 } else if (tbl8_recycle_index > -1) {
1672 /* Update tbl24 entry. */
1673 struct rte_lpm_tbl_entry_v20 new_tbl24_entry = {
1674 { .next_hop = lpm->tbl8[tbl8_recycle_index].next_hop, },
1677 .depth = lpm->tbl8[tbl8_recycle_index].depth,
1680 /* Set tbl24 before freeing tbl8 to avoid race condition. */
1681 lpm->tbl24[tbl24_index] = new_tbl24_entry;
1682 tbl8_free_v20(lpm->tbl8, tbl8_group_start);
1688 static inline int32_t
1689 delete_depth_big_v1604(struct rte_lpm *lpm, uint32_t ip_masked,
1690 uint8_t depth, int32_t sub_rule_index, uint8_t sub_rule_depth)
1692 #define group_idx next_hop
1693 uint32_t tbl24_index, tbl8_group_index, tbl8_group_start, tbl8_index,
1695 int32_t tbl8_recycle_index;
1698 * Calculate the index into tbl24 and range. Note: All depths larger
1699 * than MAX_DEPTH_TBL24 are associated with only one tbl24 entry.
1701 tbl24_index = ip_masked >> 8;
1703 /* Calculate the index into tbl8 and range. */
1704 tbl8_group_index = lpm->tbl24[tbl24_index].group_idx;
1705 tbl8_group_start = tbl8_group_index * RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
1706 tbl8_index = tbl8_group_start + (ip_masked & 0xFF);
1707 tbl8_range = depth_to_range(depth);
1709 if (sub_rule_index < 0) {
1711 * Loop through the range of entries on tbl8 for which the
1712 * rule_to_delete must be removed or modified.
1714 for (i = tbl8_index; i < (tbl8_index + tbl8_range); i++) {
1715 if (lpm->tbl8[i].depth <= depth)
1716 lpm->tbl8[i].valid = INVALID;
1719 /* Set new tbl8 entry. */
1720 struct rte_lpm_tbl_entry new_tbl8_entry = {
1722 .depth = sub_rule_depth,
1723 .valid_group = lpm->tbl8[tbl8_group_start].valid_group,
1724 .next_hop = lpm->rules_tbl[sub_rule_index].next_hop,
1728 * Loop through the range of entries on tbl8 for which the
1729 * rule_to_delete must be modified.
1731 for (i = tbl8_index; i < (tbl8_index + tbl8_range); i++) {
1732 if (lpm->tbl8[i].depth <= depth)
1733 lpm->tbl8[i] = new_tbl8_entry;
1738 * Check if there are any valid entries in this tbl8 group. If all
1739 * tbl8 entries are invalid we can free the tbl8 and invalidate the
1740 * associated tbl24 entry.
1743 tbl8_recycle_index = tbl8_recycle_check_v1604(lpm->tbl8, tbl8_group_start);
1745 if (tbl8_recycle_index == -EINVAL) {
1746 /* Set tbl24 before freeing tbl8 to avoid race condition. */
1747 lpm->tbl24[tbl24_index].valid = 0;
1748 tbl8_free_v1604(lpm->tbl8, tbl8_group_start);
1749 } else if (tbl8_recycle_index > -1) {
1750 /* Update tbl24 entry. */
1751 struct rte_lpm_tbl_entry new_tbl24_entry = {
1752 .next_hop = lpm->tbl8[tbl8_recycle_index].next_hop,
1755 .depth = lpm->tbl8[tbl8_recycle_index].depth,
1758 /* Set tbl24 before freeing tbl8 to avoid race condition. */
1759 lpm->tbl24[tbl24_index] = new_tbl24_entry;
1760 tbl8_free_v1604(lpm->tbl8, tbl8_group_start);
1770 rte_lpm_delete_v20(struct rte_lpm_v20 *lpm, uint32_t ip, uint8_t depth)
1772 int32_t rule_to_delete_index, sub_rule_index;
1774 uint8_t sub_rule_depth;
1776 * Check input arguments. Note: IP must be a positive integer of 32
1777 * bits in length therefore it need not be checked.
1779 if ((lpm == NULL) || (depth < 1) || (depth > RTE_LPM_MAX_DEPTH)) {
1783 ip_masked = ip & depth_to_mask(depth);
1786 * Find the index of the input rule, that needs to be deleted, in the
1789 rule_to_delete_index = rule_find_v20(lpm, ip_masked, depth);
1792 * Check if rule_to_delete_index was found. If no rule was found the
1793 * function rule_find returns -EINVAL.
1795 if (rule_to_delete_index < 0)
1798 /* Delete the rule from the rule table. */
1799 rule_delete_v20(lpm, rule_to_delete_index, depth);
1802 * Find rule to replace the rule_to_delete. If there is no rule to
1803 * replace the rule_to_delete we return -1 and invalidate the table
1804 * entries associated with this rule.
1807 sub_rule_index = find_previous_rule_v20(lpm, ip, depth, &sub_rule_depth);
1810 * If the input depth value is less than 25 use function
1811 * delete_depth_small otherwise use delete_depth_big.
1813 if (depth <= MAX_DEPTH_TBL24) {
1814 return delete_depth_small_v20(lpm, ip_masked, depth,
1815 sub_rule_index, sub_rule_depth);
1816 } else { /* If depth > MAX_DEPTH_TBL24 */
1817 return delete_depth_big_v20(lpm, ip_masked, depth, sub_rule_index,
1821 VERSION_SYMBOL(rte_lpm_delete, _v20, 2.0);
1824 rte_lpm_delete_v1604(struct rte_lpm *lpm, uint32_t ip, uint8_t depth)
1826 int32_t rule_to_delete_index, sub_rule_index;
1828 uint8_t sub_rule_depth;
1830 * Check input arguments. Note: IP must be a positive integer of 32
1831 * bits in length therefore it need not be checked.
1833 if ((lpm == NULL) || (depth < 1) || (depth > RTE_LPM_MAX_DEPTH)) {
1837 ip_masked = ip & depth_to_mask(depth);
1840 * Find the index of the input rule, that needs to be deleted, in the
1843 rule_to_delete_index = rule_find_v1604(lpm, ip_masked, depth);
1846 * Check if rule_to_delete_index was found. If no rule was found the
1847 * function rule_find returns -EINVAL.
1849 if (rule_to_delete_index < 0)
1852 /* Delete the rule from the rule table. */
1853 rule_delete_v1604(lpm, rule_to_delete_index, depth);
1856 * Find rule to replace the rule_to_delete. If there is no rule to
1857 * replace the rule_to_delete we return -1 and invalidate the table
1858 * entries associated with this rule.
1861 sub_rule_index = find_previous_rule_v1604(lpm, ip, depth, &sub_rule_depth);
1864 * If the input depth value is less than 25 use function
1865 * delete_depth_small otherwise use delete_depth_big.
1867 if (depth <= MAX_DEPTH_TBL24) {
1868 return delete_depth_small_v1604(lpm, ip_masked, depth,
1869 sub_rule_index, sub_rule_depth);
1870 } else { /* If depth > MAX_DEPTH_TBL24 */
1871 return delete_depth_big_v1604(lpm, ip_masked, depth, sub_rule_index,
1875 BIND_DEFAULT_SYMBOL(rte_lpm_delete, _v1604, 16.04);
1876 MAP_STATIC_SYMBOL(int rte_lpm_delete(struct rte_lpm *lpm, uint32_t ip,
1877 uint8_t depth), rte_lpm_delete_v1604);
1880 * Delete all rules from the LPM table.
1883 rte_lpm_delete_all_v20(struct rte_lpm_v20 *lpm)
1885 /* Zero rule information. */
1886 memset(lpm->rule_info, 0, sizeof(lpm->rule_info));
1889 memset(lpm->tbl24, 0, sizeof(lpm->tbl24));
1892 memset(lpm->tbl8, 0, sizeof(lpm->tbl8));
1894 /* Delete all rules form the rules table. */
1895 memset(lpm->rules_tbl, 0, sizeof(lpm->rules_tbl[0]) * lpm->max_rules);
1897 VERSION_SYMBOL(rte_lpm_delete_all, _v20, 2.0);
1900 rte_lpm_delete_all_v1604(struct rte_lpm *lpm)
1902 /* Zero rule information. */
1903 memset(lpm->rule_info, 0, sizeof(lpm->rule_info));
1906 memset(lpm->tbl24, 0, sizeof(lpm->tbl24));
1909 memset(lpm->tbl8, 0, sizeof(lpm->tbl8[0])
1910 * RTE_LPM_TBL8_GROUP_NUM_ENTRIES * lpm->number_tbl8s);
1912 /* Delete all rules form the rules table. */
1913 memset(lpm->rules_tbl, 0, sizeof(lpm->rules_tbl[0]) * lpm->max_rules);
1915 BIND_DEFAULT_SYMBOL(rte_lpm_delete_all, _v1604, 16.04);
1916 MAP_STATIC_SYMBOL(void rte_lpm_delete_all(struct rte_lpm *lpm),
1917 rte_lpm_delete_all_v1604);