xref: /freebsd/sys/netlink/route/route_var.h (revision 058ac3e8063366dafa634d9107642e12b038bf09)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2022 Alexander V. Chernikov <melifaro@FreeBSD.org>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 /*
29  * This file contains definitions shared among NETLINK_ROUTE family
30  */
31 #ifndef _NETLINK_ROUTE_ROUTE_VAR_H_
32 #define _NETLINK_ROUTE_ROUTE_VAR_H_
33 
34 #include <sys/priv.h> /* values for priv_check */
35 
36 struct nlmsghdr;
37 struct nlpcb;
38 struct nl_pstate;
39 
40 typedef int rtnl_msg_cb_f(struct nlmsghdr *hdr, struct nlpcb *nlp,
41     struct nl_pstate *npt);
42 
43 struct rtnl_cmd_handler {
44 	int		cmd;
45 	const char	*name;
46 	rtnl_msg_cb_f	*cb;
47 	int		priv;
48 	int		flags;
49 };
50 
51 #define	RTNL_F_NOEPOCH	0x01
52 
53 bool rtnl_register_messages(const struct rtnl_cmd_handler *handlers, int count);
54 
55 /* route.c */
56 struct rib_cmd_info;
57 void rtnl_handle_route_event(uint32_t fibnum, const struct rib_cmd_info *rc);
58 void rtnl_routes_init(void);
59 
60 /* neigh.c */
61 void rtnl_neighs_init(void);
62 void rtnl_neighs_destroy(void);
63 
64 /* iface.c */
65 struct nl_parsed_link {
66 	char		*ifla_group;
67 	char		*ifla_ifname;
68 	char		*ifla_cloner;
69 	char		*ifla_ifalias;
70 	struct nlattr	*ifla_idata;
71 	unsigned short	ifi_type;
72 	int		ifi_index;
73 	uint32_t	ifla_mtu;
74 	uint32_t	ifi_flags;
75 	uint32_t	ifi_change;
76 };
77 
78 typedef int rtnl_iface_create_f(struct nl_parsed_link *lattrs,
79     const struct nlattr_bmask *bm, struct nlpcb *nlp, struct nl_pstate *npt);
80 typedef int rtnl_iface_modify_f(struct ifnet *ifp, struct nl_parsed_link *lattrs,
81     const struct nlattr_bmask *bm, struct nlpcb *nlp, struct nl_pstate *npt);
82 typedef int rtnl_iface_dump_f(struct ifnet *ifp, struct nl_writer *nw);
83 
84 struct nl_cloner {
85 	const char		*name;
86 	rtnl_iface_create_f	*create_f;
87 	rtnl_iface_modify_f	*modify_f;
88 	rtnl_iface_dump_f	*dump_f;
89 	SLIST_ENTRY(nl_cloner)	next;
90 };
91 
92 extern struct nl_cloner	generic_cloner;
93 
94 void rtnl_ifaces_init(void);
95 void rtnl_ifaces_destroy(void);
96 void rtnl_iface_add_cloner(struct nl_cloner *cloner);
97 void rtnl_iface_del_cloner(struct nl_cloner *cloner);
98 void rtnl_handle_ifnet_event(struct ifnet *ifp, int if_change_mask);
99 
100 /* iface_drivers.c */
101 void rtnl_iface_drivers_register(void);
102 
103 /* nexthop.c */
104 void rtnl_nexthops_init(void);
105 struct nhop_object *nl_find_nhop(uint32_t fibnum, int family,
106     uint32_t uidx, int nh_flags, int *perror);
107 
108 
109 #endif
110