1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2018 Vladimir Medvedkin <medvedkinv@gmail.com>
3 * Copyright(c) 2019 Intel Corporation
16 * All functions in this file may be changed or removed without prior notice.
18 * FIB (Forwarding information base) implementation
19 * for IPv6 Longest Prefix Match
22 #include <rte_compat.h>
28 #define RTE_FIB6_IPV6_ADDR_SIZE 16
29 /** Maximum depth value possible for IPv6 FIB. */
30 #define RTE_FIB6_MAXDEPTH 128
35 /** Type of FIB struct */
37 RTE_FIB6_DUMMY, /**< RIB6 tree based FIB */
38 RTE_FIB6_TRIE /**< TRIE based fib */
41 /** Modify FIB function */
42 typedef int (*rte_fib6_modify_fn_t)(struct rte_fib6 *fib,
43 const uint8_t ip[RTE_FIB6_IPV6_ADDR_SIZE], uint8_t depth,
44 uint64_t next_hop, int op);
45 /** FIB bulk lookup function */
46 typedef void (*rte_fib6_lookup_fn_t)(void *fib,
47 uint8_t ips[][RTE_FIB6_IPV6_ADDR_SIZE],
48 uint64_t *next_hops, const unsigned int n);
55 /** Size of nexthop (1 << nh_sz) bits for TRIE based FIB */
56 enum rte_fib_trie_nh_sz {
62 /** Type of lookup function implementation */
63 enum rte_fib6_lookup_type {
64 RTE_FIB6_LOOKUP_DEFAULT,
65 /**< Selects the best implementation based on the max simd bitwidth */
66 RTE_FIB6_LOOKUP_TRIE_SCALAR, /**< Scalar lookup function implementation*/
67 RTE_FIB6_LOOKUP_TRIE_VECTOR_AVX512 /**< Vector implementation using AVX512 */
70 /** FIB configuration structure */
71 struct rte_fib6_conf {
72 enum rte_fib6_type type; /**< Type of FIB struct */
73 /** Default value returned on lookup if there is no route */
78 enum rte_fib_trie_nh_sz nh_sz;
90 * NUMA socket ID for FIB table memory allocation
92 * Structure containing the configuration
94 * Handle to FIB object on success
95 * NULL otherwise with rte_errno set to an appropriate values.
99 rte_fib6_create(const char *name, int socket_id, struct rte_fib6_conf *conf);
102 * Find an existing FIB object and return a pointer to it.
105 * Name of the fib object as passed to rte_fib6_create()
107 * Pointer to fib object or NULL if object not found with rte_errno
108 * set appropriately. Possible rte_errno values include:
109 * - ENOENT - required entry not available to return.
113 rte_fib6_find_existing(const char *name);
116 * Free an FIB object.
125 rte_fib6_free(struct rte_fib6 *fib);
128 * Add a route to the FIB.
133 * IPv6 prefix address to be added to the FIB
137 * Next hop to be added to the FIB
139 * 0 on success, negative value otherwise
143 rte_fib6_add(struct rte_fib6 *fib, const uint8_t ip[RTE_FIB6_IPV6_ADDR_SIZE],
144 uint8_t depth, uint64_t next_hop);
147 * Delete a rule from the FIB.
152 * IPv6 prefix address to be deleted from the FIB
156 * 0 on success, negative value otherwise
160 rte_fib6_delete(struct rte_fib6 *fib,
161 const uint8_t ip[RTE_FIB6_IPV6_ADDR_SIZE], uint8_t depth);
164 * Lookup multiple IP addresses in the FIB.
169 * Array of IPv6s to be looked up in the FIB
171 * Next hop of the most specific rule found for IP.
172 * This is an array of eight byte values.
173 * If the lookup for the given IP failed, then corresponding element would
174 * contain default nexthop value configured for a FIB.
176 * Number of elements in ips (and next_hops) array to lookup.
178 * -EINVAL for incorrect arguments, otherwise 0
182 rte_fib6_lookup_bulk(struct rte_fib6 *fib,
183 uint8_t ips[][RTE_FIB6_IPV6_ADDR_SIZE],
184 uint64_t *next_hops, int n);
187 * Get pointer to the dataplane specific struct
192 * Pointer on the dataplane struct on success
197 rte_fib6_get_dp(struct rte_fib6 *fib);
200 * Get pointer to the RIB6
205 * Pointer on the RIB6 on success
210 rte_fib6_get_rib(struct rte_fib6 *fib);
213 * Set lookup function based on type
218 * type of lookup function
226 rte_fib6_select_lookup(struct rte_fib6 *fib, enum rte_fib6_lookup_type type);
232 #endif /* _RTE_FIB6_H_ */