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",
106 if (p->name == NULL) {
107 RTE_LOG(ERR, TABLE, "%s: Table name is NULL\n",
111 entry_size = RTE_ALIGN(entry_size, sizeof(uint64_t));
113 /* Memory allocation */
114 nht_size = RTE_TABLE_LPM_MAX_NEXT_HOPS * entry_size;
115 total_size = sizeof(struct rte_table_lpm) + nht_size;
116 lpm = rte_zmalloc_socket("TABLE", total_size, RTE_CACHE_LINE_SIZE,
120 "%s: Cannot allocate %u bytes for LPM table\n",
121 __func__, total_size);
125 /* LPM low-level table creation */
126 lpm->lpm = rte_lpm_create(p->name, socket_id, p->n_rules, 0);
127 if (lpm->lpm == NULL) {
129 RTE_LOG(ERR, TABLE, "Unable to create low-level LPM table\n");
133 /* Memory initialization */
134 lpm->entry_size = entry_size;
135 lpm->entry_unique_size = p->entry_unique_size;
136 lpm->n_rules = p->n_rules;
137 lpm->offset = p->offset;
143 rte_table_lpm_free(void *table)
145 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
147 /* Check input parameters */
149 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
153 /* Free previously allocated resources */
154 rte_lpm_free(lpm->lpm);
161 nht_find_free(struct rte_table_lpm *lpm, uint32_t *pos)
165 for (i = 0; i < RTE_TABLE_LPM_MAX_NEXT_HOPS; i++) {
166 if (lpm->nht_users[i] == 0) {
176 nht_find_existing(struct rte_table_lpm *lpm, void *entry, uint32_t *pos)
180 for (i = 0; i < RTE_TABLE_LPM_MAX_NEXT_HOPS; i++) {
181 uint8_t *nht_entry = &lpm->nht[i * lpm->entry_size];
183 if ((lpm->nht_users[i] > 0) && (memcmp(nht_entry, entry,
184 lpm->entry_unique_size) == 0)) {
194 rte_table_lpm_entry_add(
201 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
202 struct rte_table_lpm_key *ip_prefix = (struct rte_table_lpm_key *) key;
203 uint32_t nht_pos, nht_pos0_valid;
205 uint8_t nht_pos0 = 0;
207 /* Check input parameters */
209 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
212 if (ip_prefix == NULL) {
213 RTE_LOG(ERR, TABLE, "%s: ip_prefix parameter is NULL\n",
218 RTE_LOG(ERR, TABLE, "%s: entry parameter is NULL\n", __func__);
222 if ((ip_prefix->depth == 0) || (ip_prefix->depth > 32)) {
223 RTE_LOG(ERR, TABLE, "%s: invalid depth (%d)\n",
224 __func__, ip_prefix->depth);
228 /* Check if rule is already present in the table */
229 status = rte_lpm_is_rule_present(lpm->lpm, ip_prefix->ip,
230 ip_prefix->depth, &nht_pos0);
231 nht_pos0_valid = status > 0;
233 /* Find existing or free NHT entry */
234 if (nht_find_existing(lpm, entry, &nht_pos) == 0) {
237 if (nht_find_free(lpm, &nht_pos) == 0) {
238 RTE_LOG(ERR, TABLE, "%s: NHT full\n", __func__);
242 nht_entry = &lpm->nht[nht_pos * lpm->entry_size];
243 memcpy(nht_entry, entry, lpm->entry_size);
246 /* Add rule to low level LPM table */
247 if (rte_lpm_add(lpm->lpm, ip_prefix->ip, ip_prefix->depth,
248 (uint8_t) nht_pos) < 0) {
249 RTE_LOG(ERR, TABLE, "%s: LPM rule add failed\n", __func__);
253 /* Commit NHT changes */
254 lpm->nht_users[nht_pos]++;
255 lpm->nht_users[nht_pos0] -= nht_pos0_valid;
257 *key_found = nht_pos0_valid;
258 *entry_ptr = (void *) &lpm->nht[nht_pos * lpm->entry_size];
263 rte_table_lpm_entry_delete(
269 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
270 struct rte_table_lpm_key *ip_prefix = (struct rte_table_lpm_key *) key;
274 /* Check input parameters */
276 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
279 if (ip_prefix == NULL) {
280 RTE_LOG(ERR, TABLE, "%s: ip_prefix parameter is NULL\n",
284 if ((ip_prefix->depth == 0) || (ip_prefix->depth > 32)) {
285 RTE_LOG(ERR, TABLE, "%s: invalid depth (%d)\n", __func__,
290 /* Return if rule is not present in the table */
291 status = rte_lpm_is_rule_present(lpm->lpm, ip_prefix->ip,
292 ip_prefix->depth, &nht_pos);
294 RTE_LOG(ERR, TABLE, "%s: LPM algorithmic error\n", __func__);
302 /* Delete rule from the low-level LPM table */
303 status = rte_lpm_delete(lpm->lpm, ip_prefix->ip, ip_prefix->depth);
305 RTE_LOG(ERR, TABLE, "%s: LPM rule delete failed\n", __func__);
309 /* Commit NHT changes */
310 lpm->nht_users[nht_pos]--;
314 memcpy(entry, &lpm->nht[nht_pos * lpm->entry_size],
321 rte_table_lpm_lookup(
323 struct rte_mbuf **pkts,
325 uint64_t *lookup_hit_mask,
328 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
329 uint64_t pkts_out_mask = 0;
332 __rte_unused uint32_t n_pkts_in = __builtin_popcountll(pkts_mask);
333 RTE_TABLE_LPM_STATS_PKTS_IN_ADD(lpm, n_pkts_in);
336 for (i = 0; i < (uint32_t)(RTE_PORT_IN_BURST_SIZE_MAX -
337 __builtin_clzll(pkts_mask)); i++) {
338 uint64_t pkt_mask = 1LLU << i;
340 if (pkt_mask & pkts_mask) {
341 struct rte_mbuf *pkt = pkts[i];
342 uint32_t ip = rte_bswap32(
343 RTE_MBUF_METADATA_UINT32(pkt, lpm->offset));
347 status = rte_lpm_lookup(lpm->lpm, ip, &nht_pos);
349 pkts_out_mask |= pkt_mask;
350 entries[i] = (void *) &lpm->nht[nht_pos *
356 *lookup_hit_mask = pkts_out_mask;
357 RTE_TABLE_LPM_STATS_PKTS_LOOKUP_MISS(lpm, n_pkts_in - __builtin_popcountll(pkts_out_mask));
362 rte_table_lpm_stats_read(void *table, struct rte_table_stats *stats, int clear)
364 struct rte_table_lpm *t = (struct rte_table_lpm *) table;
367 memcpy(stats, &t->stats, sizeof(t->stats));
370 memset(&t->stats, 0, sizeof(t->stats));
375 struct rte_table_ops rte_table_lpm_ops = {
376 .f_create = rte_table_lpm_create,
377 .f_free = rte_table_lpm_free,
378 .f_add = rte_table_lpm_entry_add,
379 .f_delete = rte_table_lpm_entry_delete,
380 .f_lookup = rte_table_lpm_lookup,
381 .f_stats = rte_table_lpm_stats_read,