1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2018 Vladimir Medvedkin <medvedkinv@gmail.com>
3 * Copyright(c) 2019 Intel Corporation
11 * FIB (Forwarding information base) implementation
12 * for IPv4 Longest Prefix Match
15 #include <rte_compat.h>
24 /** Maximum depth value possible for IPv4 FIB. */
25 #define RTE_FIB_MAXDEPTH 32
27 /** Type of FIB struct */
29 RTE_FIB_DUMMY, /**< RIB tree based FIB */
30 RTE_FIB_DIR24_8, /**< DIR24_8 based FIB */
34 /** Modify FIB function */
35 typedef int (*rte_fib_modify_fn_t)(struct rte_fib *fib, uint32_t ip,
36 uint8_t depth, uint64_t next_hop, int op);
37 /** FIB bulk lookup function */
38 typedef void (*rte_fib_lookup_fn_t)(void *fib, const uint32_t *ips,
39 uint64_t *next_hops, const unsigned int n);
46 /** Size of nexthop (1 << nh_sz) bits for DIR24_8 based FIB */
47 enum rte_fib_dir24_8_nh_sz {
54 /** FIB configuration structure */
56 enum rte_fib_type type; /**< Type of FIB struct */
57 /** Default value returned on lookup if there is no route */
62 enum rte_fib_dir24_8_nh_sz nh_sz;
74 * NUMA socket ID for FIB table memory allocation
76 * Structure containing the configuration
78 * Handle to the FIB object on success
79 * NULL otherwise with rte_errno set to an appropriate values.
83 rte_fib_create(const char *name, int socket_id, struct rte_fib_conf *conf);
86 * Find an existing FIB object and return a pointer to it.
89 * Name of the fib object as passed to rte_fib_create()
91 * Pointer to fib object or NULL if object not found with rte_errno
92 * set appropriately. Possible rte_errno values include:
93 * - ENOENT - required entry not available to return.
97 rte_fib_find_existing(const char *name);
100 * Free an FIB object.
109 rte_fib_free(struct rte_fib *fib);
112 * Add a route to the FIB.
117 * IPv4 prefix address to be added to the FIB
121 * Next hop to be added to the FIB
123 * 0 on success, negative value otherwise
127 rte_fib_add(struct rte_fib *fib, uint32_t ip, uint8_t depth, uint64_t next_hop);
130 * Delete a rule from the FIB.
135 * IPv4 prefix address to be deleted from the FIB
139 * 0 on success, negative value otherwise
143 rte_fib_delete(struct rte_fib *fib, uint32_t ip, uint8_t depth);
146 * Lookup multiple IP addresses in the FIB.
151 * Array of IPs to be looked up in the FIB
153 * Next hop of the most specific rule found for IP.
154 * This is an array of eight byte values.
155 * If the lookup for the given IP failed, then corresponding element would
156 * contain default nexthop value configured for a FIB.
158 * Number of elements in ips (and next_hops) array to lookup.
160 * -EINVAL for incorrect arguments, otherwise 0
164 rte_fib_lookup_bulk(struct rte_fib *fib, uint32_t *ips,
165 uint64_t *next_hops, int n);
167 * Get pointer to the dataplane specific struct
172 * Pointer on the dataplane struct on success
177 rte_fib_get_dp(struct rte_fib *fib);
180 * Get pointer to the RIB
185 * Pointer on the RIB on success
190 rte_fib_get_rib(struct rte_fib *fib);
196 #endif /* _RTE_FIB_H_ */