DPDK  22.07.0
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 <stdint.h>
16 #include <rte_branch_prediction.h>
17 #include <rte_byteorder.h>
18 #include <rte_common.h>
19 #include <rte_vect.h>
20 #include <rte_rcu_qsbr.h>
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25 
27 #define RTE_LPM_NAMESIZE 32
28 
30 #define RTE_LPM_MAX_DEPTH 32
31 
33 #define RTE_LPM_TBL24_NUM_ENTRIES (1 << 24)
34 
36 #define RTE_LPM_TBL8_GROUP_NUM_ENTRIES 256
37 
39 #define RTE_LPM_MAX_TBL8_NUM_GROUPS (1 << 24)
40 
42 #define RTE_LPM_TBL8_NUM_GROUPS 256
43 
45 #define RTE_LPM_TBL8_NUM_ENTRIES (RTE_LPM_TBL8_NUM_GROUPS * \
46  RTE_LPM_TBL8_GROUP_NUM_ENTRIES)
47 
49 #if defined(RTE_LIBRTE_LPM_DEBUG)
50 #define RTE_LPM_RETURN_IF_TRUE(cond, retval) do { \
51  if (cond) return (retval); \
52 } while (0)
53 #else
54 #define RTE_LPM_RETURN_IF_TRUE(cond, retval)
55 #endif
56 
58 #define RTE_LPM_VALID_EXT_ENTRY_BITMASK 0x03000000
59 
61 #define RTE_LPM_LOOKUP_SUCCESS 0x01000000
62 
64 #define RTE_LPM_RCU_DQ_RECLAIM_MAX 16
65 
72 };
73 
74 #if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
75 
76 __extension__
77 struct rte_lpm_tbl_entry {
83  uint32_t next_hop :24;
84  /* Using single uint8_t to store 3 values. */
85  uint32_t valid :1;
93  uint32_t valid_group :1;
94  uint32_t depth :6;
95 };
96 
97 #else
98 
99 __extension__
100 struct rte_lpm_tbl_entry {
101  uint32_t depth :6;
102  uint32_t valid_group :1;
103  uint32_t valid :1;
104  uint32_t next_hop :24;
105 
106 };
107 
108 #endif
109 
112  uint32_t max_rules;
113  uint32_t number_tbl8s;
114  int flags;
115 };
116 
118 struct rte_lpm {
119  /* LPM Tables. */
120  struct rte_lpm_tbl_entry tbl24[RTE_LPM_TBL24_NUM_ENTRIES]
121  __rte_cache_aligned;
122  struct rte_lpm_tbl_entry *tbl8;
123 };
124 
127  struct rte_rcu_qsbr *v; /* RCU QSBR variable. */
128  /* Mode of RCU QSBR. RTE_LPM_QSBR_MODE_xxx
129  * '0' for default: create defer queue for reclaim.
130  */
131  enum rte_lpm_qsbr_mode mode;
132  uint32_t dq_size; /* RCU defer queue size.
133  * default: lpm->number_tbl8s.
134  */
135  uint32_t reclaim_thd; /* Threshold to trigger auto reclaim. */
136  uint32_t reclaim_max; /* Max entries to reclaim in one go.
137  * default: RTE_LPM_RCU_DQ_RECLAIM_MAX.
138  */
139 };
140 
160 struct rte_lpm *
161 rte_lpm_create(const char *name, int socket_id,
162  const struct rte_lpm_config *config);
163 
174 struct rte_lpm *
175 rte_lpm_find_existing(const char *name);
176 
186 void
187 rte_lpm_free(struct rte_lpm *lpm);
188 
207 __rte_experimental
208 int rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg);
209 
224 int
225 rte_lpm_add(struct rte_lpm *lpm, uint32_t ip, uint8_t depth, uint32_t next_hop);
226 
242 int
243 rte_lpm_is_rule_present(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
244 uint32_t *next_hop);
245 
258 int
259 rte_lpm_delete(struct rte_lpm *lpm, uint32_t ip, uint8_t depth);
260 
267 void
268 rte_lpm_delete_all(struct rte_lpm *lpm);
269 
282 static inline int
283 rte_lpm_lookup(const struct rte_lpm *lpm, uint32_t ip, uint32_t *next_hop)
284 {
285  unsigned tbl24_index = (ip >> 8);
286  uint32_t tbl_entry;
287  const uint32_t *ptbl;
288 
289  /* DEBUG: Check user input arguments. */
290  RTE_LPM_RETURN_IF_TRUE(((lpm == NULL) || (next_hop == NULL)), -EINVAL);
291 
292  /* Copy tbl24 entry */
293  ptbl = (const uint32_t *)(&lpm->tbl24[tbl24_index]);
294  tbl_entry = *ptbl;
295 
296  /* Memory ordering is not required in lookup. Because dataflow
297  * dependency exists, compiler or HW won't be able to re-order
298  * the operations.
299  */
300  /* Copy tbl8 entry (only if needed) */
301  if (unlikely((tbl_entry & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
302  RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
303 
304  unsigned tbl8_index = (uint8_t)ip +
305  (((uint32_t)tbl_entry & 0x00FFFFFF) *
306  RTE_LPM_TBL8_GROUP_NUM_ENTRIES);
307 
308  ptbl = (const uint32_t *)&lpm->tbl8[tbl8_index];
309  tbl_entry = *ptbl;
310  }
311 
312  *next_hop = ((uint32_t)tbl_entry & 0x00FFFFFF);
313  return (tbl_entry & RTE_LPM_LOOKUP_SUCCESS) ? 0 : -ENOENT;
314 }
315 
336 #define rte_lpm_lookup_bulk(lpm, ips, next_hops, n) \
337  rte_lpm_lookup_bulk_func(lpm, ips, next_hops, n)
338 
339 static inline int
340 rte_lpm_lookup_bulk_func(const struct rte_lpm *lpm, const uint32_t *ips,
341  uint32_t *next_hops, const unsigned n)
342 {
343  unsigned i;
344  unsigned tbl24_indexes[n];
345  const uint32_t *ptbl;
346 
347  /* DEBUG: Check user input arguments. */
348  RTE_LPM_RETURN_IF_TRUE(((lpm == NULL) || (ips == NULL) ||
349  (next_hops == NULL)), -EINVAL);
350 
351  for (i = 0; i < n; i++) {
352  tbl24_indexes[i] = ips[i] >> 8;
353  }
354 
355  for (i = 0; i < n; i++) {
356  /* Simply copy tbl24 entry to output */
357  ptbl = (const uint32_t *)&lpm->tbl24[tbl24_indexes[i]];
358  next_hops[i] = *ptbl;
359 
360  /* Overwrite output with tbl8 entry if needed */
361  if (unlikely((next_hops[i] & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
362  RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
363 
364  unsigned tbl8_index = (uint8_t)ips[i] +
365  (((uint32_t)next_hops[i] & 0x00FFFFFF) *
366  RTE_LPM_TBL8_GROUP_NUM_ENTRIES);
367 
368  ptbl = (const uint32_t *)&lpm->tbl8[tbl8_index];
369  next_hops[i] = *ptbl;
370  }
371  }
372  return 0;
373 }
374 
375 /* Mask four results. */
376 #define RTE_LPM_MASKX4_RES UINT64_C(0x00ffffff00ffffff)
377 
397 static inline void
398 rte_lpm_lookupx4(const struct rte_lpm *lpm, xmm_t ip, uint32_t hop[4],
399  uint32_t defv);
400 
401 #if defined(RTE_ARCH_ARM)
402 #ifdef RTE_HAS_SVE_ACLE
403 #include "rte_lpm_sve.h"
404 #else
405 #include "rte_lpm_neon.h"
406 #endif
407 #elif defined(RTE_ARCH_PPC_64)
408 #include "rte_lpm_altivec.h"
409 #elif defined(RTE_ARCH_X86)
410 #include "rte_lpm_sse.h"
411 #else
412 #include "rte_lpm_scalar.h"
413 #endif
414 
415 #ifdef __cplusplus
416 }
417 #endif
418 
419 #endif /* _RTE_LPM_H_ */
void rte_lpm_free(struct rte_lpm *lpm)
__rte_experimental int rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg)
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)
rte_lpm_qsbr_mode
Definition: rte_lpm.h:67
uint32_t max_rules
Definition: rte_lpm.h:112
#define unlikely(x)
static int rte_lpm_lookup(const struct rte_lpm *lpm, uint32_t ip, uint32_t *next_hop)
Definition: rte_lpm.h:283
static void rte_lpm_lookupx4(const struct rte_lpm *lpm, xmm_t ip, uint32_t hop[4], uint32_t defv)
uint32_t number_tbl8s
Definition: rte_lpm.h:113
int rte_lpm_delete(struct rte_lpm *lpm, uint32_t ip, uint8_t depth)
#define RTE_LPM_LOOKUP_SUCCESS
Definition: rte_lpm.h:61
int rte_lpm_add(struct rte_lpm *lpm, uint32_t ip, uint8_t depth, uint32_t next_hop)
int rte_lpm_is_rule_present(struct rte_lpm *lpm, uint32_t ip, uint8_t depth, uint32_t *next_hop)
struct rte_lpm * rte_lpm_find_existing(const char *name)