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 struct rte_table_lpm {
50 /* Input parameters */
52 uint32_t entry_unique_size;
56 /* Handle to low-level LPM table */
59 /* Next Hop Table (NHT) */
60 uint32_t nht_users[RTE_TABLE_LPM_MAX_NEXT_HOPS];
61 uint8_t nht[0] __rte_cache_aligned;
65 rte_table_lpm_create(void *params, int socket_id, uint32_t entry_size)
67 struct rte_table_lpm_params *p = (struct rte_table_lpm_params *) params;
68 struct rte_table_lpm *lpm;
69 uint32_t total_size, nht_size;
71 /* Check input parameters */
73 RTE_LOG(ERR, TABLE, "%s: NULL input parameters\n", __func__);
76 if (p->n_rules == 0) {
77 RTE_LOG(ERR, TABLE, "%s: Invalid n_rules\n", __func__);
80 if (p->entry_unique_size == 0) {
81 RTE_LOG(ERR, TABLE, "%s: Invalid entry_unique_size\n",
85 if (p->entry_unique_size > entry_size) {
86 RTE_LOG(ERR, TABLE, "%s: Invalid entry_unique_size\n",
90 if ((p->offset & 0x3) != 0) {
91 RTE_LOG(ERR, TABLE, "%s: Invalid offset\n", __func__);
95 entry_size = RTE_ALIGN(entry_size, sizeof(uint64_t));
97 /* Memory allocation */
98 nht_size = RTE_TABLE_LPM_MAX_NEXT_HOPS * entry_size;
99 total_size = sizeof(struct rte_table_lpm) + nht_size;
100 lpm = rte_zmalloc_socket("TABLE", total_size, RTE_CACHE_LINE_SIZE,
104 "%s: Cannot allocate %u bytes for LPM table\n",
105 __func__, total_size);
109 /* LPM low-level table creation */
110 lpm->lpm = rte_lpm_create("LPM", socket_id, p->n_rules, 0);
111 if (lpm->lpm == NULL) {
113 RTE_LOG(ERR, TABLE, "Unable to create low-level LPM table\n");
117 /* Memory initialization */
118 lpm->entry_size = entry_size;
119 lpm->entry_unique_size = p->entry_unique_size;
120 lpm->n_rules = p->n_rules;
121 lpm->offset = p->offset;
127 rte_table_lpm_free(void *table)
129 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
131 /* Check input parameters */
133 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
137 /* Free previously allocated resources */
138 rte_lpm_free(lpm->lpm);
145 nht_find_free(struct rte_table_lpm *lpm, uint32_t *pos)
149 for (i = 0; i < RTE_TABLE_LPM_MAX_NEXT_HOPS; i++) {
150 if (lpm->nht_users[i] == 0) {
160 nht_find_existing(struct rte_table_lpm *lpm, void *entry, uint32_t *pos)
164 for (i = 0; i < RTE_TABLE_LPM_MAX_NEXT_HOPS; i++) {
165 uint8_t *nht_entry = &lpm->nht[i * lpm->entry_size];
167 if ((lpm->nht_users[i] > 0) && (memcmp(nht_entry, entry,
168 lpm->entry_unique_size) == 0)) {
178 rte_table_lpm_entry_add(
185 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
186 struct rte_table_lpm_key *ip_prefix = (struct rte_table_lpm_key *) key;
187 uint32_t nht_pos, nht_pos0_valid;
189 uint8_t nht_pos0 = 0;
191 /* Check input parameters */
193 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
196 if (ip_prefix == NULL) {
197 RTE_LOG(ERR, TABLE, "%s: ip_prefix parameter is NULL\n",
202 RTE_LOG(ERR, TABLE, "%s: entry parameter is NULL\n", __func__);
206 if ((ip_prefix->depth == 0) || (ip_prefix->depth > 32)) {
207 RTE_LOG(ERR, TABLE, "%s: invalid depth (%d)\n",
208 __func__, ip_prefix->depth);
212 /* Check if rule is already present in the table */
213 status = rte_lpm_is_rule_present(lpm->lpm, ip_prefix->ip,
214 ip_prefix->depth, &nht_pos0);
215 nht_pos0_valid = status > 0;
217 /* Find existing or free NHT entry */
218 if (nht_find_existing(lpm, entry, &nht_pos) == 0) {
221 if (nht_find_free(lpm, &nht_pos) == 0) {
222 RTE_LOG(ERR, TABLE, "%s: NHT full\n", __func__);
226 nht_entry = &lpm->nht[nht_pos * lpm->entry_size];
227 memcpy(nht_entry, entry, lpm->entry_size);
230 /* Add rule to low level LPM table */
231 if (rte_lpm_add(lpm->lpm, ip_prefix->ip, ip_prefix->depth,
232 (uint8_t) nht_pos) < 0) {
233 RTE_LOG(ERR, TABLE, "%s: LPM rule add failed\n", __func__);
237 /* Commit NHT changes */
238 lpm->nht_users[nht_pos]++;
239 lpm->nht_users[nht_pos0] -= nht_pos0_valid;
241 *key_found = nht_pos0_valid;
242 *entry_ptr = (void *) &lpm->nht[nht_pos * lpm->entry_size];
247 rte_table_lpm_entry_delete(
253 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
254 struct rte_table_lpm_key *ip_prefix = (struct rte_table_lpm_key *) key;
258 /* Check input parameters */
260 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
263 if (ip_prefix == NULL) {
264 RTE_LOG(ERR, TABLE, "%s: ip_prefix parameter is NULL\n",
268 if ((ip_prefix->depth == 0) || (ip_prefix->depth > 32)) {
269 RTE_LOG(ERR, TABLE, "%s: invalid depth (%d)\n", __func__,
274 /* Return if rule is not present in the table */
275 status = rte_lpm_is_rule_present(lpm->lpm, ip_prefix->ip,
276 ip_prefix->depth, &nht_pos);
278 RTE_LOG(ERR, TABLE, "%s: LPM algorithmic error\n", __func__);
286 /* Delete rule from the low-level LPM table */
287 status = rte_lpm_delete(lpm->lpm, ip_prefix->ip, ip_prefix->depth);
289 RTE_LOG(ERR, TABLE, "%s: LPM rule delete failed\n", __func__);
293 /* Commit NHT changes */
294 lpm->nht_users[nht_pos]--;
298 memcpy(entry, &lpm->nht[nht_pos * lpm->entry_size],
305 rte_table_lpm_lookup(
307 struct rte_mbuf **pkts,
309 uint64_t *lookup_hit_mask,
312 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
313 uint64_t pkts_out_mask = 0;
317 for (i = 0; i < (uint32_t)(RTE_PORT_IN_BURST_SIZE_MAX -
318 __builtin_clzll(pkts_mask)); i++) {
319 uint64_t pkt_mask = 1LLU << i;
321 if (pkt_mask & pkts_mask) {
322 struct rte_mbuf *pkt = pkts[i];
323 uint32_t ip = rte_bswap32(
324 RTE_MBUF_METADATA_UINT32(pkt, lpm->offset));
328 status = rte_lpm_lookup(lpm->lpm, ip, &nht_pos);
330 pkts_out_mask |= pkt_mask;
331 entries[i] = (void *) &lpm->nht[nht_pos *
337 *lookup_hit_mask = pkts_out_mask;
342 struct rte_table_ops rte_table_lpm_ops = {
343 .f_create = rte_table_lpm_create,
344 .f_free = rte_table_lpm_free,
345 .f_add = rte_table_lpm_entry_add,
346 .f_delete = rte_table_lpm_entry_delete,
347 .f_lookup = rte_table_lpm_lookup,