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",
91 entry_size = RTE_ALIGN(entry_size, sizeof(uint64_t));
93 /* Memory allocation */
94 nht_size = RTE_TABLE_LPM_MAX_NEXT_HOPS * entry_size;
95 total_size = sizeof(struct rte_table_lpm) + nht_size;
96 lpm = rte_zmalloc_socket("TABLE", total_size, RTE_CACHE_LINE_SIZE,
100 "%s: Cannot allocate %u bytes for LPM table\n",
101 __func__, total_size);
105 /* LPM low-level table creation */
106 lpm->lpm = rte_lpm_create("LPM", socket_id, p->n_rules, 0);
107 if (lpm->lpm == NULL) {
109 RTE_LOG(ERR, TABLE, "Unable to create low-level LPM table\n");
113 /* Memory initialization */
114 lpm->entry_size = entry_size;
115 lpm->entry_unique_size = p->entry_unique_size;
116 lpm->n_rules = p->n_rules;
117 lpm->offset = p->offset;
123 rte_table_lpm_free(void *table)
125 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
127 /* Check input parameters */
129 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
133 /* Free previously allocated resources */
134 rte_lpm_free(lpm->lpm);
141 nht_find_free(struct rte_table_lpm *lpm, uint32_t *pos)
145 for (i = 0; i < RTE_TABLE_LPM_MAX_NEXT_HOPS; i++) {
146 if (lpm->nht_users[i] == 0) {
156 nht_find_existing(struct rte_table_lpm *lpm, void *entry, uint32_t *pos)
160 for (i = 0; i < RTE_TABLE_LPM_MAX_NEXT_HOPS; i++) {
161 uint8_t *nht_entry = &lpm->nht[i * lpm->entry_size];
163 if ((lpm->nht_users[i] > 0) && (memcmp(nht_entry, entry,
164 lpm->entry_unique_size) == 0)) {
174 rte_table_lpm_entry_add(
181 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
182 struct rte_table_lpm_key *ip_prefix = (struct rte_table_lpm_key *) key;
183 uint32_t nht_pos, nht_pos0_valid;
185 uint8_t nht_pos0 = 0;
187 /* Check input parameters */
189 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
192 if (ip_prefix == NULL) {
193 RTE_LOG(ERR, TABLE, "%s: ip_prefix parameter is NULL\n",
198 RTE_LOG(ERR, TABLE, "%s: entry parameter is NULL\n", __func__);
202 if ((ip_prefix->depth == 0) || (ip_prefix->depth > 32)) {
203 RTE_LOG(ERR, TABLE, "%s: invalid depth (%d)\n",
204 __func__, ip_prefix->depth);
208 /* Check if rule is already present in the table */
209 status = rte_lpm_is_rule_present(lpm->lpm, ip_prefix->ip,
210 ip_prefix->depth, &nht_pos0);
211 nht_pos0_valid = status > 0;
213 /* Find existing or free NHT entry */
214 if (nht_find_existing(lpm, entry, &nht_pos) == 0) {
217 if (nht_find_free(lpm, &nht_pos) == 0) {
218 RTE_LOG(ERR, TABLE, "%s: NHT full\n", __func__);
222 nht_entry = &lpm->nht[nht_pos * lpm->entry_size];
223 memcpy(nht_entry, entry, lpm->entry_size);
226 /* Add rule to low level LPM table */
227 if (rte_lpm_add(lpm->lpm, ip_prefix->ip, ip_prefix->depth,
228 (uint8_t) nht_pos) < 0) {
229 RTE_LOG(ERR, TABLE, "%s: LPM rule add failed\n", __func__);
233 /* Commit NHT changes */
234 lpm->nht_users[nht_pos]++;
235 lpm->nht_users[nht_pos0] -= nht_pos0_valid;
237 *key_found = nht_pos0_valid;
238 *entry_ptr = (void *) &lpm->nht[nht_pos * lpm->entry_size];
243 rte_table_lpm_entry_delete(
249 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
250 struct rte_table_lpm_key *ip_prefix = (struct rte_table_lpm_key *) key;
254 /* Check input parameters */
256 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
259 if (ip_prefix == NULL) {
260 RTE_LOG(ERR, TABLE, "%s: ip_prefix parameter is NULL\n",
264 if ((ip_prefix->depth == 0) || (ip_prefix->depth > 32)) {
265 RTE_LOG(ERR, TABLE, "%s: invalid depth (%d)\n", __func__,
270 /* Return if rule is not present in the table */
271 status = rte_lpm_is_rule_present(lpm->lpm, ip_prefix->ip,
272 ip_prefix->depth, &nht_pos);
274 RTE_LOG(ERR, TABLE, "%s: LPM algorithmic error\n", __func__);
282 /* Delete rule from the low-level LPM table */
283 status = rte_lpm_delete(lpm->lpm, ip_prefix->ip, ip_prefix->depth);
285 RTE_LOG(ERR, TABLE, "%s: LPM rule delete failed\n", __func__);
289 /* Commit NHT changes */
290 lpm->nht_users[nht_pos]--;
294 memcpy(entry, &lpm->nht[nht_pos * lpm->entry_size],
301 rte_table_lpm_lookup(
303 struct rte_mbuf **pkts,
305 uint64_t *lookup_hit_mask,
308 struct rte_table_lpm *lpm = (struct rte_table_lpm *) table;
309 uint64_t pkts_out_mask = 0;
313 for (i = 0; i < (uint32_t)(RTE_PORT_IN_BURST_SIZE_MAX -
314 __builtin_clzll(pkts_mask)); i++) {
315 uint64_t pkt_mask = 1LLU << i;
317 if (pkt_mask & pkts_mask) {
318 struct rte_mbuf *pkt = pkts[i];
319 uint32_t ip = rte_bswap32(
320 RTE_MBUF_METADATA_UINT32(pkt, lpm->offset));
324 status = rte_lpm_lookup(lpm->lpm, ip, &nht_pos);
326 pkts_out_mask |= pkt_mask;
327 entries[i] = (void *) &lpm->nht[nht_pos *
333 *lookup_hit_mask = pkts_out_mask;
338 struct rte_table_ops rte_table_lpm_ops = {
339 .f_create = rte_table_lpm_create,
340 .f_free = rte_table_lpm_free,
341 .f_add = rte_table_lpm_entry_add,
342 .f_delete = rte_table_lpm_entry_delete,
343 .f_lookup = rte_table_lpm_lookup,