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>
20 /** Maximum depth value possible for IPv4 FIB. */
21 #define RTE_FIB_MAXDEPTH 32
23 /** Type of FIB struct */
25 RTE_FIB_DUMMY, /**< RIB tree based FIB */
26 RTE_FIB_DIR24_8, /**< DIR24_8 based FIB */
30 /** Modify FIB function */
31 typedef int (*rte_fib_modify_fn_t)(struct rte_fib *fib, uint32_t ip,
32 uint8_t depth, uint64_t next_hop, int op);
33 /** FIB bulk lookup function */
34 typedef void (*rte_fib_lookup_fn_t)(void *fib, const uint32_t *ips,
35 uint64_t *next_hops, const unsigned int n);
42 /** Size of nexthop (1 << nh_sz) bits for DIR24_8 based FIB */
43 enum rte_fib_dir24_8_nh_sz {
50 /** FIB configuration structure */
52 enum rte_fib_type type; /**< Type of FIB struct */
53 /** Default value returned on lookup if there is no route */
58 enum rte_fib_dir24_8_nh_sz nh_sz;
70 * NUMA socket ID for FIB table memory allocation
72 * Structure containing the configuration
74 * Handle to the FIB object on success
75 * NULL otherwise with rte_errno set to an appropriate values.
79 rte_fib_create(const char *name, int socket_id, struct rte_fib_conf *conf);
82 * Find an existing FIB object and return a pointer to it.
85 * Name of the fib object as passed to rte_fib_create()
87 * Pointer to fib object or NULL if object not found with rte_errno
88 * set appropriately. Possible rte_errno values include:
89 * - ENOENT - required entry not available to return.
93 rte_fib_find_existing(const char *name);
105 rte_fib_free(struct rte_fib *fib);
108 * Add a route to the FIB.
113 * IPv4 prefix address to be added to the FIB
117 * Next hop to be added to the FIB
119 * 0 on success, negative value otherwise
123 rte_fib_add(struct rte_fib *fib, uint32_t ip, uint8_t depth, uint64_t next_hop);
126 * Delete a rule from the FIB.
131 * IPv4 prefix address to be deleted from the FIB
135 * 0 on success, negative value otherwise
139 rte_fib_delete(struct rte_fib *fib, uint32_t ip, uint8_t depth);
142 * Lookup multiple IP addresses in the FIB.
147 * Array of IPs to be looked up in the FIB
149 * Next hop of the most specific rule found for IP.
150 * This is an array of eight byte values.
151 * If the lookup for the given IP failed, then corresponding element would
152 * contain default nexthop value configured for a FIB.
154 * Number of elements in ips (and next_hops) array to lookup.
156 * -EINVAL for incorrect arguments, otherwise 0
160 rte_fib_lookup_bulk(struct rte_fib *fib, uint32_t *ips,
161 uint64_t *next_hops, int n);
163 * Get pointer to the dataplane specific struct
168 * Pointer on the dataplane struct on success
173 rte_fib_get_dp(struct rte_fib *fib);
176 * Get pointer to the RIB
181 * Pointer on the RIB on success
186 rte_fib_get_rib(struct rte_fib *fib);
188 #endif /* _RTE_FIB_H_ */