DPDK 25.03.0-rc0
rte_lpm.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
3 * Copyright(c) 2020 Arm Limited
4 */
5
6#ifndef _RTE_LPM_H_
7#define _RTE_LPM_H_
8
14#include <errno.h>
15#include <stdalign.h>
16#include <stdint.h>
17
19#include <rte_byteorder.h>
20#include <rte_common.h>
21#include <rte_vect.h>
22#include <rte_rcu_qsbr.h>
23
24#ifdef __cplusplus
25extern "C" {
26#endif
27
29#define RTE_LPM_NAMESIZE 32
30
32#define RTE_LPM_MAX_DEPTH 32
33
35#define RTE_LPM_TBL24_NUM_ENTRIES (1 << 24)
36
38#define RTE_LPM_TBL8_GROUP_NUM_ENTRIES 256
39
41#define RTE_LPM_MAX_TBL8_NUM_GROUPS (1 << 24)
42
44#define RTE_LPM_TBL8_NUM_GROUPS 256
45
47#define RTE_LPM_TBL8_NUM_ENTRIES (RTE_LPM_TBL8_NUM_GROUPS * \
48 RTE_LPM_TBL8_GROUP_NUM_ENTRIES)
49
51#if defined(RTE_LIBRTE_LPM_DEBUG)
52#define RTE_LPM_RETURN_IF_TRUE(cond, retval) do { \
53 if (cond) return (retval); \
54} while (0)
55#else
56#define RTE_LPM_RETURN_IF_TRUE(cond, retval)
57#endif
58
60#define RTE_LPM_VALID_EXT_ENTRY_BITMASK 0x03000000
61
63#define RTE_LPM_LOOKUP_SUCCESS 0x01000000
64
66#define RTE_LPM_RCU_DQ_RECLAIM_MAX 16
67
74};
75
76#if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
78__extension__
79struct rte_lpm_tbl_entry {
85 uint32_t next_hop :24;
86 /* Using single uint8_t to store 3 values. */
87 uint32_t valid :1;
95 uint32_t valid_group :1;
96 uint32_t depth :6;
97};
98
99#else
100
101__extension__
102struct rte_lpm_tbl_entry {
103 uint32_t depth :6;
104 uint32_t valid_group :1;
105 uint32_t valid :1;
106 uint32_t next_hop :24;
107
108};
109
110#endif
111
114 uint32_t max_rules;
115 uint32_t number_tbl8s;
116 int flags;
117};
118
120struct rte_lpm {
121 /* LPM Tables. */
122 alignas(RTE_CACHE_LINE_SIZE) struct rte_lpm_tbl_entry tbl24[RTE_LPM_TBL24_NUM_ENTRIES];
124 struct rte_lpm_tbl_entry *tbl8;
125};
126
129 struct rte_rcu_qsbr *v; /* RCU QSBR variable. */
130 /* Mode of RCU QSBR. RTE_LPM_QSBR_MODE_xxx
131 * '0' for default: create defer queue for reclaim.
132 */
133 enum rte_lpm_qsbr_mode mode;
134 uint32_t dq_size; /* RCU defer queue size.
135 * default: lpm->number_tbl8s.
136 */
137 uint32_t reclaim_thd; /* Threshold to trigger auto reclaim. */
138 uint32_t reclaim_max; /* Max entries to reclaim in one go.
139 * default: RTE_LPM_RCU_DQ_RECLAIM_MAX.
140 */
141};
142
162struct rte_lpm *
163rte_lpm_create(const char *name, int socket_id,
164 const struct rte_lpm_config *config);
165
176struct rte_lpm *
177rte_lpm_find_existing(const char *name);
178
186void
187rte_lpm_free(struct rte_lpm *lpm);
188
204int rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg);
205
220int
221rte_lpm_add(struct rte_lpm *lpm, uint32_t ip, uint8_t depth, uint32_t next_hop);
222
238int
239rte_lpm_is_rule_present(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
240uint32_t *next_hop);
241
254int
255rte_lpm_delete(struct rte_lpm *lpm, uint32_t ip, uint8_t depth);
256
263void
264rte_lpm_delete_all(struct rte_lpm *lpm);
265
278static inline int
279rte_lpm_lookup(const struct rte_lpm *lpm, uint32_t ip, uint32_t *next_hop)
280{
281 unsigned tbl24_index = (ip >> 8);
282 uint32_t tbl_entry;
283 const uint32_t *ptbl;
284
285 /* DEBUG: Check user input arguments. */
286 RTE_LPM_RETURN_IF_TRUE(((lpm == NULL) || (next_hop == NULL)), -EINVAL);
287
288 /* Copy tbl24 entry */
289 ptbl = (const uint32_t *)(&lpm->tbl24[tbl24_index]);
290 tbl_entry = *ptbl;
291
292 /* Memory ordering is not required in lookup. Because dataflow
293 * dependency exists, compiler or HW won't be able to re-order
294 * the operations.
295 */
296 /* Copy tbl8 entry (only if needed) */
297 if (unlikely((tbl_entry & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
298 RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
299
300 unsigned tbl8_index = (uint8_t)ip +
301 (((uint32_t)tbl_entry & 0x00FFFFFF) *
302 RTE_LPM_TBL8_GROUP_NUM_ENTRIES);
303
304 ptbl = (const uint32_t *)&lpm->tbl8[tbl8_index];
305 tbl_entry = *ptbl;
306 }
307
308 *next_hop = ((uint32_t)tbl_entry & 0x00FFFFFF);
309 return (tbl_entry & RTE_LPM_LOOKUP_SUCCESS) ? 0 : -ENOENT;
310}
311
332#define rte_lpm_lookup_bulk(lpm, ips, next_hops, n) \
333 rte_lpm_lookup_bulk_func(lpm, ips, next_hops, n)
334
335static inline int
336rte_lpm_lookup_bulk_func(const struct rte_lpm *lpm, const uint32_t *ips,
337 uint32_t *next_hops, const unsigned n)
338{
339 unsigned i;
340 const uint32_t *ptbl;
341
342 /* DEBUG: Check user input arguments. */
343 RTE_LPM_RETURN_IF_TRUE(((lpm == NULL) || (ips == NULL) ||
344 (next_hops == NULL)), -EINVAL);
345
346 for (i = 0; i < n; i++) {
347 unsigned int tbl24_index = ips[i] >> 8;
348
349 /* Simply copy tbl24 entry to output */
350 ptbl = (const uint32_t *)&lpm->tbl24[tbl24_index];
351 next_hops[i] = *ptbl;
352
353 /* Overwrite output with tbl8 entry if needed */
354 if (unlikely((next_hops[i] & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
355 RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
356
357 unsigned tbl8_index = (uint8_t)ips[i] +
358 (((uint32_t)next_hops[i] & 0x00FFFFFF) *
359 RTE_LPM_TBL8_GROUP_NUM_ENTRIES);
360
361 ptbl = (const uint32_t *)&lpm->tbl8[tbl8_index];
362 next_hops[i] = *ptbl;
363 }
364 }
365 return 0;
366}
367
368/* Mask four results. */
369#define RTE_LPM_MASKX4_RES UINT64_C(0x00ffffff00ffffff)
370
390static inline void
391rte_lpm_lookupx4(const struct rte_lpm *lpm, xmm_t ip, uint32_t hop[4],
392 uint32_t defv);
393
394#ifdef __cplusplus
395}
396#endif
397
398#if defined(RTE_ARCH_ARM)
399#ifdef RTE_HAS_SVE_ACLE
400#include "rte_lpm_sve.h"
401#undef rte_lpm_lookup_bulk
402#define rte_lpm_lookup_bulk(lpm, ips, next_hops, n) \
403 __rte_lpm_lookup_vec(lpm, ips, next_hops, n)
404#endif
405#include "rte_lpm_neon.h"
406#elif defined(RTE_ARCH_PPC_64)
407#include "rte_lpm_altivec.h"
408#elif defined(RTE_ARCH_X86)
409#include "rte_lpm_sse.h"
410#else
411#include "rte_lpm_scalar.h"
412#endif
413
414#endif /* _RTE_LPM_H_ */
#define unlikely(x)
int rte_lpm_add(struct rte_lpm *lpm, uint32_t ip, uint8_t depth, uint32_t next_hop)
int rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg)
int rte_lpm_delete(struct rte_lpm *lpm, uint32_t ip, uint8_t depth)
void rte_lpm_free(struct rte_lpm *lpm)
static void rte_lpm_lookupx4(const struct rte_lpm *lpm, xmm_t ip, uint32_t hop[4], uint32_t defv)
#define RTE_LPM_LOOKUP_SUCCESS
Definition: rte_lpm.h:63
rte_lpm_qsbr_mode
Definition: rte_lpm.h:69
@ RTE_LPM_QSBR_MODE_DQ
Definition: rte_lpm.h:71
@ RTE_LPM_QSBR_MODE_SYNC
Definition: rte_lpm.h:73
struct rte_lpm * rte_lpm_create(const char *name, int socket_id, const struct rte_lpm_config *config)
void rte_lpm_delete_all(struct rte_lpm *lpm)
int rte_lpm_is_rule_present(struct rte_lpm *lpm, uint32_t ip, uint8_t depth, uint32_t *next_hop)
static int rte_lpm_lookup(const struct rte_lpm *lpm, uint32_t ip, uint32_t *next_hop)
Definition: rte_lpm.h:279
struct rte_lpm * rte_lpm_find_existing(const char *name)
uint32_t number_tbl8s
Definition: rte_lpm.h:115
uint32_t max_rules
Definition: rte_lpm.h:114