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.
37 #include <rte_common.h>
39 #include <rte_memory.h>
40 #include <rte_malloc.h>
41 #include <rte_byteorder.h>
45 #include "rte_table_lpm.h"
47 #define RTE_TABLE_LPM_MAX_NEXT_HOPS 256
49 #ifdef RTE_TABLE_STATS_COLLECT
51 #define RTE_TABLE_LPM_STATS_PKTS_IN_ADD(table, val) \
52 table->stats.n_pkts_in += val
53 #define RTE_TABLE_LPM_STATS_PKTS_LOOKUP_MISS(table, val) \
54 table->stats.n_pkts_lookup_miss += val
58 #define RTE_TABLE_LPM_STATS_PKTS_IN_ADD(table, val)
59 #define RTE_TABLE_LPM_STATS_PKTS_LOOKUP_MISS(table, val)
63 struct rte_table_lpm {
64 struct rte_table_stats stats;
66 /* Input parameters */
68 uint32_t entry_unique_size;
72 /* Handle to low-level LPM table */
75 /* Next Hop Table (NHT) */
76 uint32_t nht_users[RTE_TABLE_LPM_MAX_NEXT_HOPS];
77 uint8_t nht[0] __rte_cache_aligned;
81 rte_table_lpm_create(void *params, int socket_id, uint32_t entry_size)
83 struct rte_table_lpm_params *p = (struct rte_table_lpm_params *) params;
84 struct rte_table_lpm *lpm;
85 uint32_t total_size, nht_size;
87 /* Check input parameters */
89 RTE_LOG(ERR, TABLE, "%s: NULL input parameters\n", __func__);
92 if (p->n_rules == 0) {
93 RTE_LOG(ERR, TABLE, "%s: Invalid n_rules\n", __func__);
96 if (p->entry_unique_size == 0) {
97 RTE_LOG(ERR, TABLE, "%s: Invalid entry_unique_size\n",
101 if (p->entry_unique_size > entry_size) {
102 RTE_LOG(ERR, TABLE, "%s: Invalid entry_unique_size\n",
107 entry_size = RTE_ALIGN(entry_size, sizeof(uint64_t));
109 /* Memory allocation */
110 nht_size = RTE_TABLE_LPM_MAX_NEXT_HOPS * entry_size;
111 total_size = sizeof(struct rte_table_lpm) + nht_size;
112 lpm = rte_zmalloc_socket("TABLE", total_size, RTE_CACHE_LINE_SIZE,
116 "%s: Cannot allocate %u bytes for LPM table\n",
117 __func__, total_size);
121 /* LPM low-level table creation */
122 lpm->lpm = rte_lpm_create("LPM", socket_id, p->n_rules, 0);
123 if (lpm->lpm == NULL) {
125 RTE_LOG(ERR, TABLE, "Unable to create low-level LPM table\n");
129 /* Memory initialization */
130 lpm->entry_size = entry_size;
131 lpm->entry_unique_size = p->entry_unique_size;
132 lpm->n_rules = p->n_rules;
133 lpm->offset = p->offset;
139 rte_table_lpm_free(void *table)
141 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
143 /* Check input parameters */
145 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
149 /* Free previously allocated resources */
150 rte_lpm_free(lpm->lpm);
157 nht_find_free(struct rte_table_lpm *lpm, uint32_t *pos)
161 for (i = 0; i < RTE_TABLE_LPM_MAX_NEXT_HOPS; i++) {
162 if (lpm->nht_users[i] == 0) {
172 nht_find_existing(struct rte_table_lpm *lpm, void *entry, uint32_t *pos)
176 for (i = 0; i < RTE_TABLE_LPM_MAX_NEXT_HOPS; i++) {
177 uint8_t *nht_entry = &lpm->nht[i * lpm->entry_size];
179 if ((lpm->nht_users[i] > 0) && (memcmp(nht_entry, entry,
180 lpm->entry_unique_size) == 0)) {
190 rte_table_lpm_entry_add(
197 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
198 struct rte_table_lpm_key *ip_prefix = (struct rte_table_lpm_key *) key;
199 uint32_t nht_pos, nht_pos0_valid;
201 uint8_t nht_pos0 = 0;
203 /* Check input parameters */
205 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
208 if (ip_prefix == NULL) {
209 RTE_LOG(ERR, TABLE, "%s: ip_prefix parameter is NULL\n",
214 RTE_LOG(ERR, TABLE, "%s: entry parameter is NULL\n", __func__);
218 if ((ip_prefix->depth == 0) || (ip_prefix->depth > 32)) {
219 RTE_LOG(ERR, TABLE, "%s: invalid depth (%d)\n",
220 __func__, ip_prefix->depth);
224 /* Check if rule is already present in the table */
225 status = rte_lpm_is_rule_present(lpm->lpm, ip_prefix->ip,
226 ip_prefix->depth, &nht_pos0);
227 nht_pos0_valid = status > 0;
229 /* Find existing or free NHT entry */
230 if (nht_find_existing(lpm, entry, &nht_pos) == 0) {
233 if (nht_find_free(lpm, &nht_pos) == 0) {
234 RTE_LOG(ERR, TABLE, "%s: NHT full\n", __func__);
238 nht_entry = &lpm->nht[nht_pos * lpm->entry_size];
239 memcpy(nht_entry, entry, lpm->entry_size);
242 /* Add rule to low level LPM table */
243 if (rte_lpm_add(lpm->lpm, ip_prefix->ip, ip_prefix->depth,
244 (uint8_t) nht_pos) < 0) {
245 RTE_LOG(ERR, TABLE, "%s: LPM rule add failed\n", __func__);
249 /* Commit NHT changes */
250 lpm->nht_users[nht_pos]++;
251 lpm->nht_users[nht_pos0] -= nht_pos0_valid;
253 *key_found = nht_pos0_valid;
254 *entry_ptr = (void *) &lpm->nht[nht_pos * lpm->entry_size];
259 rte_table_lpm_entry_delete(
265 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
266 struct rte_table_lpm_key *ip_prefix = (struct rte_table_lpm_key *) key;
270 /* Check input parameters */
272 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
275 if (ip_prefix == NULL) {
276 RTE_LOG(ERR, TABLE, "%s: ip_prefix parameter is NULL\n",
280 if ((ip_prefix->depth == 0) || (ip_prefix->depth > 32)) {
281 RTE_LOG(ERR, TABLE, "%s: invalid depth (%d)\n", __func__,
286 /* Return if rule is not present in the table */
287 status = rte_lpm_is_rule_present(lpm->lpm, ip_prefix->ip,
288 ip_prefix->depth, &nht_pos);
290 RTE_LOG(ERR, TABLE, "%s: LPM algorithmic error\n", __func__);
298 /* Delete rule from the low-level LPM table */
299 status = rte_lpm_delete(lpm->lpm, ip_prefix->ip, ip_prefix->depth);
301 RTE_LOG(ERR, TABLE, "%s: LPM rule delete failed\n", __func__);
305 /* Commit NHT changes */
306 lpm->nht_users[nht_pos]--;
310 memcpy(entry, &lpm->nht[nht_pos * lpm->entry_size],
317 rte_table_lpm_lookup(
319 struct rte_mbuf **pkts,
321 uint64_t *lookup_hit_mask,
324 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
325 uint64_t pkts_out_mask = 0;
328 __rte_unused uint32_t n_pkts_in = __builtin_popcountll(pkts_mask);
329 RTE_TABLE_LPM_STATS_PKTS_IN_ADD(lpm, n_pkts_in);
332 for (i = 0; i < (uint32_t)(RTE_PORT_IN_BURST_SIZE_MAX -
333 __builtin_clzll(pkts_mask)); i++) {
334 uint64_t pkt_mask = 1LLU << i;
336 if (pkt_mask & pkts_mask) {
337 struct rte_mbuf *pkt = pkts[i];
338 uint32_t ip = rte_bswap32(
339 RTE_MBUF_METADATA_UINT32(pkt, lpm->offset));
343 status = rte_lpm_lookup(lpm->lpm, ip, &nht_pos);
345 pkts_out_mask |= pkt_mask;
346 entries[i] = (void *) &lpm->nht[nht_pos *
352 *lookup_hit_mask = pkts_out_mask;
353 RTE_TABLE_LPM_STATS_PKTS_LOOKUP_MISS(lpm, n_pkts_in - __builtin_popcountll(pkts_out_mask));
358 rte_table_lpm_stats_read(void *table, struct rte_table_stats *stats, int clear)
360 struct rte_table_lpm *t = (struct rte_table_lpm *) table;
363 memcpy(stats, &t->stats, sizeof(t->stats));
366 memset(&t->stats, 0, sizeof(t->stats));
371 struct rte_table_ops rte_table_lpm_ops = {
372 .f_create = rte_table_lpm_create,
373 .f_free = rte_table_lpm_free,
374 .f_add = rte_table_lpm_entry_add,
375 .f_delete = rte_table_lpm_entry_delete,
376 .f_lookup = rte_table_lpm_lookup,
377 .f_stats = rte_table_lpm_stats_read,