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 IPv4 Longest Prefix Match
22 #include <rte_compat.h>
31 /** Maximum depth value possible for IPv4 FIB. */
32 #define RTE_FIB_MAXDEPTH 32
34 /** Type of FIB struct */
36 RTE_FIB_DUMMY, /**< RIB tree based FIB */
37 RTE_FIB_DIR24_8 /**< DIR24_8 based FIB */
40 /** Modify FIB function */
41 typedef int (*rte_fib_modify_fn_t)(struct rte_fib *fib, uint32_t ip,
42 uint8_t depth, uint64_t next_hop, int op);
43 /** FIB bulk lookup function */
44 typedef void (*rte_fib_lookup_fn_t)(void *fib, const uint32_t *ips,
45 uint64_t *next_hops, const unsigned int n);
52 /** Size of nexthop (1 << nh_sz) bits for DIR24_8 based FIB */
53 enum rte_fib_dir24_8_nh_sz {
60 /** Type of lookup function implementation */
61 enum rte_fib_lookup_type {
62 RTE_FIB_LOOKUP_DEFAULT,
63 /**< Selects the best implementation based on the max simd bitwidth */
64 RTE_FIB_LOOKUP_DIR24_8_SCALAR_MACRO,
65 /**< Macro based lookup function */
66 RTE_FIB_LOOKUP_DIR24_8_SCALAR_INLINE,
68 * Lookup implementation using inlined functions
69 * for different next hop sizes
71 RTE_FIB_LOOKUP_DIR24_8_SCALAR_UNI,
73 * Unified lookup function for all next hop sizes
75 RTE_FIB_LOOKUP_DIR24_8_VECTOR_AVX512
76 /**< Vector implementation using AVX512 */
79 /** FIB configuration structure */
81 enum rte_fib_type type; /**< Type of FIB struct */
82 /** Default value returned on lookup if there is no route */
87 enum rte_fib_dir24_8_nh_sz nh_sz;
99 * NUMA socket ID for FIB table memory allocation
101 * Structure containing the configuration
103 * Handle to the FIB object on success
104 * NULL otherwise with rte_errno set to an appropriate values.
108 rte_fib_create(const char *name, int socket_id, struct rte_fib_conf *conf);
111 * Find an existing FIB object and return a pointer to it.
114 * Name of the fib object as passed to rte_fib_create()
116 * Pointer to fib object or NULL if object not found with rte_errno
117 * set appropriately. Possible rte_errno values include:
118 * - ENOENT - required entry not available to return.
122 rte_fib_find_existing(const char *name);
125 * Free an FIB object.
134 rte_fib_free(struct rte_fib *fib);
137 * Add a route to the FIB.
142 * IPv4 prefix address to be added to the FIB
146 * Next hop to be added to the FIB
148 * 0 on success, negative value otherwise
152 rte_fib_add(struct rte_fib *fib, uint32_t ip, uint8_t depth, uint64_t next_hop);
155 * Delete a rule from the FIB.
160 * IPv4 prefix address to be deleted from the FIB
164 * 0 on success, negative value otherwise
168 rte_fib_delete(struct rte_fib *fib, uint32_t ip, uint8_t depth);
171 * Lookup multiple IP addresses in the FIB.
176 * Array of IPs to be looked up in the FIB
178 * Next hop of the most specific rule found for IP.
179 * This is an array of eight byte values.
180 * If the lookup for the given IP failed, then corresponding element would
181 * contain default nexthop value configured for a FIB.
183 * Number of elements in ips (and next_hops) array to lookup.
185 * -EINVAL for incorrect arguments, otherwise 0
189 rte_fib_lookup_bulk(struct rte_fib *fib, uint32_t *ips,
190 uint64_t *next_hops, int n);
192 * Get pointer to the dataplane specific struct
197 * Pointer on the dataplane struct on success
202 rte_fib_get_dp(struct rte_fib *fib);
205 * Get pointer to the RIB
210 * Pointer on the RIB on success
215 rte_fib_get_rib(struct rte_fib *fib);
218 * Set lookup function based on type
223 * type of lookup function
231 rte_fib_select_lookup(struct rte_fib *fib, enum rte_fib_lookup_type type);
237 #endif /* _RTE_FIB_H_ */