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 */
42 /** Modify FIB function */
43 typedef int (*rte_fib6_modify_fn_t)(struct rte_fib6 *fib,
44 const uint8_t ip[RTE_FIB6_IPV6_ADDR_SIZE], uint8_t depth,
45 uint64_t next_hop, int op);
46 /** FIB bulk lookup function */
47 typedef void (*rte_fib6_lookup_fn_t)(void *fib,
48 uint8_t ips[][RTE_FIB6_IPV6_ADDR_SIZE],
49 uint64_t *next_hops, const unsigned int n);
56 enum rte_fib_trie_nh_sz {
62 /** FIB configuration structure */
63 struct rte_fib6_conf {
64 enum rte_fib6_type type; /**< Type of FIB struct */
65 /** Default value returned on lookup if there is no route */
70 enum rte_fib_trie_nh_sz nh_sz;
82 * NUMA socket ID for FIB table memory allocation
84 * Structure containing the configuration
86 * Handle to FIB object on success
87 * NULL otherwise with rte_errno set to an appropriate values.
91 rte_fib6_create(const char *name, int socket_id, struct rte_fib6_conf *conf);
94 * Find an existing FIB object and return a pointer to it.
97 * Name of the fib object as passed to rte_fib6_create()
99 * Pointer to fib object or NULL if object not found with rte_errno
100 * set appropriately. Possible rte_errno values include:
101 * - ENOENT - required entry not available to return.
105 rte_fib6_find_existing(const char *name);
108 * Free an FIB object.
117 rte_fib6_free(struct rte_fib6 *fib);
120 * Add a route to the FIB.
125 * IPv6 prefix address to be added to the FIB
129 * Next hop to be added to the FIB
131 * 0 on success, negative value otherwise
135 rte_fib6_add(struct rte_fib6 *fib, const uint8_t ip[RTE_FIB6_IPV6_ADDR_SIZE],
136 uint8_t depth, uint64_t next_hop);
139 * Delete a rule from the FIB.
144 * IPv6 prefix address to be deleted from the FIB
148 * 0 on success, negative value otherwise
152 rte_fib6_delete(struct rte_fib6 *fib,
153 const uint8_t ip[RTE_FIB6_IPV6_ADDR_SIZE], uint8_t depth);
156 * Lookup multiple IP addresses in the FIB.
161 * Array of IPv6s to be looked up in the FIB
163 * Next hop of the most specific rule found for IP.
164 * This is an array of eight byte values.
165 * If the lookup for the given IP failed, then corresponding element would
166 * contain default nexthop value configured for a FIB.
168 * Number of elements in ips (and next_hops) array to lookup.
170 * -EINVAL for incorrect arguments, otherwise 0
174 rte_fib6_lookup_bulk(struct rte_fib6 *fib,
175 uint8_t ips[][RTE_FIB6_IPV6_ADDR_SIZE],
176 uint64_t *next_hops, int n);
179 * Get pointer to the dataplane specific struct
184 * Pointer on the dataplane struct on success
189 rte_fib6_get_dp(struct rte_fib6 *fib);
192 * Get pointer to the RIB6
197 * Pointer on the RIB6 on success
202 rte_fib6_get_rib(struct rte_fib6 *fib);
208 #endif /* _RTE_FIB6_H_ */