xref: /freebsd/sys/net/route/fib_algo.h (revision f5baf8bb12f39d0e8d64508c47eb6c4386ef716d)
1*f5baf8bbSAlexander V. Chernikov /*-
2*f5baf8bbSAlexander V. Chernikov  * Copyright (c) 2020
3*f5baf8bbSAlexander V. Chernikov  * 	Alexander V. Chernikov <melifaro@FreeBSD.org>
4*f5baf8bbSAlexander V. Chernikov  *
5*f5baf8bbSAlexander V. Chernikov  * Redistribution and use in source and binary forms, with or without
6*f5baf8bbSAlexander V. Chernikov  * modification, are permitted provided that the following conditions
7*f5baf8bbSAlexander V. Chernikov  * are met:
8*f5baf8bbSAlexander V. Chernikov  * 1. Redistributions of source code must retain the above copyright
9*f5baf8bbSAlexander V. Chernikov  *    notice, this list of conditions and the following disclaimer.
10*f5baf8bbSAlexander V. Chernikov  * 2. Redistributions in binary form must reproduce the above copyright
11*f5baf8bbSAlexander V. Chernikov  *    notice, this list of conditions and the following disclaimer in the
12*f5baf8bbSAlexander V. Chernikov  *    documentation and/or other materials provided with the distribution.
13*f5baf8bbSAlexander V. Chernikov  * 3. Neither the name of the University nor the names of its contributors
14*f5baf8bbSAlexander V. Chernikov  *    may be used to endorse or promote products derived from this software
15*f5baf8bbSAlexander V. Chernikov  *    without specific prior written permission.
16*f5baf8bbSAlexander V. Chernikov  *
17*f5baf8bbSAlexander V. Chernikov  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18*f5baf8bbSAlexander V. Chernikov  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19*f5baf8bbSAlexander V. Chernikov  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20*f5baf8bbSAlexander V. Chernikov  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21*f5baf8bbSAlexander V. Chernikov  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22*f5baf8bbSAlexander V. Chernikov  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23*f5baf8bbSAlexander V. Chernikov  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24*f5baf8bbSAlexander V. Chernikov  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25*f5baf8bbSAlexander V. Chernikov  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26*f5baf8bbSAlexander V. Chernikov  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27*f5baf8bbSAlexander V. Chernikov  * SUCH DAMAGE.
28*f5baf8bbSAlexander V. Chernikov  *
29*f5baf8bbSAlexander V. Chernikov  * $FreeBSD$
30*f5baf8bbSAlexander V. Chernikov  */
31*f5baf8bbSAlexander V. Chernikov 
32*f5baf8bbSAlexander V. Chernikov 
33*f5baf8bbSAlexander V. Chernikov struct fib_data;
34*f5baf8bbSAlexander V. Chernikov struct fib_dp;
35*f5baf8bbSAlexander V. Chernikov enum flm_op_result {
36*f5baf8bbSAlexander V. Chernikov 	FLM_SUCCESS,	/* No errors, operation successful */
37*f5baf8bbSAlexander V. Chernikov 	FLM_REBUILD,	/* Operation cannot be completed, schedule algorithm rebuild */
38*f5baf8bbSAlexander V. Chernikov 	FLM_ERROR,	/* Operation failed, this algo cannot be used */
39*f5baf8bbSAlexander V. Chernikov };
40*f5baf8bbSAlexander V. Chernikov 
41*f5baf8bbSAlexander V. Chernikov struct rib_rtable_info {
42*f5baf8bbSAlexander V. Chernikov 	uint32_t num_prefixes;
43*f5baf8bbSAlexander V. Chernikov 	uint32_t num_nhops;
44*f5baf8bbSAlexander V. Chernikov 	uint32_t num_nhgrp;
45*f5baf8bbSAlexander V. Chernikov };
46*f5baf8bbSAlexander V. Chernikov 
47*f5baf8bbSAlexander V. Chernikov struct flm_lookup_key {
48*f5baf8bbSAlexander V. Chernikov 	union {
49*f5baf8bbSAlexander V. Chernikov 		const struct in6_addr *addr6;
50*f5baf8bbSAlexander V. Chernikov 		struct in_addr addr4;
51*f5baf8bbSAlexander V. Chernikov 	};
52*f5baf8bbSAlexander V. Chernikov };
53*f5baf8bbSAlexander V. Chernikov 
54*f5baf8bbSAlexander V. Chernikov typedef struct nhop_object *flm_lookup_t(void *algo_data,
55*f5baf8bbSAlexander V. Chernikov     const struct flm_lookup_key key, uint32_t scopeid);
56*f5baf8bbSAlexander V. Chernikov typedef enum flm_op_result flm_init_t (uint32_t fibnum, struct fib_data *fd,
57*f5baf8bbSAlexander V. Chernikov     void *_old_data, void **new_data);
58*f5baf8bbSAlexander V. Chernikov typedef void flm_destroy_t(void *data);
59*f5baf8bbSAlexander V. Chernikov typedef enum flm_op_result flm_dump_t(struct rtentry *rt, void *data);
60*f5baf8bbSAlexander V. Chernikov typedef enum flm_op_result flm_dump_end_t(void *data, struct fib_dp *dp);
61*f5baf8bbSAlexander V. Chernikov typedef enum flm_op_result flm_change_t(struct rib_head *rnh,
62*f5baf8bbSAlexander V. Chernikov     struct rib_cmd_info *rc, void *data);
63*f5baf8bbSAlexander V. Chernikov typedef uint8_t flm_get_pref_t(const struct rib_rtable_info *rinfo);
64*f5baf8bbSAlexander V. Chernikov 
65*f5baf8bbSAlexander V. Chernikov struct fib_lookup_module {
66*f5baf8bbSAlexander V. Chernikov 	char		*flm_name;		/* algo name */
67*f5baf8bbSAlexander V. Chernikov 	int		flm_family;		/* address family this module supports */
68*f5baf8bbSAlexander V. Chernikov 	int		flm_refcount;		/* # of references */
69*f5baf8bbSAlexander V. Chernikov 	uint32_t	flm_flags;		/* flags */
70*f5baf8bbSAlexander V. Chernikov 	uint8_t		flm_index;		/* internal algo index */
71*f5baf8bbSAlexander V. Chernikov 	flm_init_t	*flm_init_cb;		/* instance init */
72*f5baf8bbSAlexander V. Chernikov 	flm_destroy_t	*flm_destroy_cb;		/* destroy instance */
73*f5baf8bbSAlexander V. Chernikov 	flm_change_t	*flm_change_rib_item_cb;/* routing table change hook */
74*f5baf8bbSAlexander V. Chernikov 	flm_dump_t	*flm_dump_rib_item_cb;	/* routing table dump cb */
75*f5baf8bbSAlexander V. Chernikov 	flm_dump_end_t	*flm_dump_end_cb;	/* end of dump */
76*f5baf8bbSAlexander V. Chernikov 	flm_lookup_t	*flm_lookup;		/* lookup function */
77*f5baf8bbSAlexander V. Chernikov 	flm_get_pref_t	*flm_get_pref;		/* get algo preference */
78*f5baf8bbSAlexander V. Chernikov 	TAILQ_ENTRY(fib_lookup_module)	entries;
79*f5baf8bbSAlexander V. Chernikov };
80*f5baf8bbSAlexander V. Chernikov 
81*f5baf8bbSAlexander V. Chernikov /* Datapath lookup data */
82*f5baf8bbSAlexander V. Chernikov struct fib_dp {
83*f5baf8bbSAlexander V. Chernikov 	flm_lookup_t	*f;
84*f5baf8bbSAlexander V. Chernikov 	void		*arg;
85*f5baf8bbSAlexander V. Chernikov };
86*f5baf8bbSAlexander V. Chernikov 
87*f5baf8bbSAlexander V. Chernikov VNET_DECLARE(struct fib_dp *, inet_dp);
88*f5baf8bbSAlexander V. Chernikov #define	V_inet_dp	VNET(inet_dp)
89*f5baf8bbSAlexander V. Chernikov VNET_DECLARE(struct fib_dp *, inet6_dp);
90*f5baf8bbSAlexander V. Chernikov #define	V_inet6_dp	VNET(inet6_dp)
91*f5baf8bbSAlexander V. Chernikov 
92*f5baf8bbSAlexander V. Chernikov #define	FIB_PRINTF(_l, _fd, _fmt, ...)	fib_printf(_l, _fd, __func__, _fmt, ##__VA_ARGS__)
93*f5baf8bbSAlexander V. Chernikov 
94*f5baf8bbSAlexander V. Chernikov void fib_printf(int level, struct fib_data *fd, const char *func, char *fmt, ...);
95*f5baf8bbSAlexander V. Chernikov int fib_module_init(struct fib_lookup_module *flm, uint32_t fibnum,
96*f5baf8bbSAlexander V. Chernikov     int family);
97*f5baf8bbSAlexander V. Chernikov int fib_module_clone(const struct fib_lookup_module *flm_orig,
98*f5baf8bbSAlexander V. Chernikov     struct fib_lookup_module *flm, bool waitok);
99*f5baf8bbSAlexander V. Chernikov int fib_module_dumptree(struct fib_lookup_module *flm,
100*f5baf8bbSAlexander V. Chernikov     enum rib_subscription_type subscription_type);
101*f5baf8bbSAlexander V. Chernikov int fib_module_register(struct fib_lookup_module *flm);
102*f5baf8bbSAlexander V. Chernikov int fib_module_unregister(struct fib_lookup_module *flm);
103*f5baf8bbSAlexander V. Chernikov 
104*f5baf8bbSAlexander V. Chernikov uint32_t fib_get_nhop_idx(struct fib_data *fd, struct nhop_object *nh);
105*f5baf8bbSAlexander V. Chernikov struct nhop_object **fib_get_nhop_array(struct fib_data *fd);
106*f5baf8bbSAlexander V. Chernikov void fib_get_rtable_info(struct rib_head *rh, struct rib_rtable_info *rinfo);
107*f5baf8bbSAlexander V. Chernikov struct rib_head *fib_get_rh(struct fib_data *fd);
108*f5baf8bbSAlexander V. Chernikov 
109*f5baf8bbSAlexander V. Chernikov 
110