1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2018 Vladimir Medvedkin <medvedkinv@gmail.com>
3 * Copyright(c) 2019 Intel Corporation
14 * FIB (Forwarding information base) implementation
15 * for IPv4 Longest Prefix Match
20 #include <rte_compat.h>
29 /** Maximum depth value possible for IPv4 FIB. */
30 #define RTE_FIB_MAXDEPTH 32
32 /** Type of FIB struct */
34 RTE_FIB_DUMMY, /**< RIB tree based FIB */
35 RTE_FIB_DIR24_8 /**< DIR24_8 based FIB */
38 /** Modify FIB function */
39 typedef int (*rte_fib_modify_fn_t)(struct rte_fib *fib, uint32_t ip,
40 uint8_t depth, uint64_t next_hop, int op);
41 /** FIB bulk lookup function */
42 typedef void (*rte_fib_lookup_fn_t)(void *fib, const uint32_t *ips,
43 uint64_t *next_hops, const unsigned int n);
50 /** Size of nexthop (1 << nh_sz) bits for DIR24_8 based FIB */
51 enum rte_fib_dir24_8_nh_sz {
58 /** Type of lookup function implementation */
59 enum rte_fib_lookup_type {
60 RTE_FIB_LOOKUP_DEFAULT,
61 /**< Selects the best implementation based on the max simd bitwidth */
62 RTE_FIB_LOOKUP_DIR24_8_SCALAR_MACRO,
63 /**< Macro based lookup function */
64 RTE_FIB_LOOKUP_DIR24_8_SCALAR_INLINE,
66 * Lookup implementation using inlined functions
67 * for different next hop sizes
69 RTE_FIB_LOOKUP_DIR24_8_SCALAR_UNI,
71 * Unified lookup function for all next hop sizes
73 RTE_FIB_LOOKUP_DIR24_8_VECTOR_AVX512
74 /**< Vector implementation using AVX512 */
77 /** FIB configuration structure */
79 enum rte_fib_type type; /**< Type of FIB struct */
80 /** Default value returned on lookup if there is no route */
85 enum rte_fib_dir24_8_nh_sz nh_sz;
97 * NUMA socket ID for FIB table memory allocation
99 * Structure containing the configuration
101 * Handle to the FIB object on success
102 * NULL otherwise with rte_errno set to an appropriate values.
105 rte_fib_create(const char *name, int socket_id, struct rte_fib_conf *conf);
108 * Find an existing FIB object and return a pointer to it.
111 * Name of the fib object as passed to rte_fib_create()
113 * Pointer to fib object or NULL if object not found with rte_errno
114 * set appropriately. Possible rte_errno values include:
115 * - ENOENT - required entry not available to return.
118 rte_fib_find_existing(const char *name);
121 * Free an FIB object.
129 rte_fib_free(struct rte_fib *fib);
132 * Add a route to the FIB.
137 * IPv4 prefix address to be added to the FIB
141 * Next hop to be added to the FIB
143 * 0 on success, negative value otherwise
146 rte_fib_add(struct rte_fib *fib, uint32_t ip, uint8_t depth, uint64_t next_hop);
149 * Delete a rule from the FIB.
154 * IPv4 prefix address to be deleted from the FIB
158 * 0 on success, negative value otherwise
161 rte_fib_delete(struct rte_fib *fib, uint32_t ip, uint8_t depth);
164 * Lookup multiple IP addresses in the FIB.
169 * Array of IPs 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
181 rte_fib_lookup_bulk(struct rte_fib *fib, uint32_t *ips,
182 uint64_t *next_hops, int n);
184 * Get pointer to the dataplane specific struct
189 * Pointer on the dataplane struct on success
193 rte_fib_get_dp(struct rte_fib *fib);
196 * Get pointer to the RIB
201 * Pointer on the RIB on success
205 rte_fib_get_rib(struct rte_fib *fib);
208 * Set lookup function based on type
213 * type of lookup function
220 rte_fib_select_lookup(struct rte_fib *fib, enum rte_fib_lookup_type type);
226 #endif /* _RTE_FIB_H_ */