xref: /freebsd/sys/netlink/route/route_var.h (revision 089104e0e01f080c9cd45dc5f34c4f636dea4ca7)
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	/* Do not enter epoch when handling command */
52 #define	RTNL_F_ALLOW_NONVNET_JAIL	0x02	/* Allow command execution inside non-VNET jail */
53 
54 bool rtnl_register_messages(const struct rtnl_cmd_handler *handlers, int count);
55 
56 /* route.c */
57 struct rib_cmd_info;
58 void rtnl_handle_route_event(uint32_t fibnum, const struct rib_cmd_info *rc);
59 void rtnl_routes_init(void);
60 
61 /* neigh.c */
62 void rtnl_neighs_init(void);
63 void rtnl_neighs_destroy(void);
64 
65 /* iface.c */
66 struct nl_parsed_link {
67 	char		*ifla_group;
68 	char		*ifla_ifname;
69 	char		*ifla_cloner;
70 	char		*ifla_ifalias;
71 	struct nlattr	*ifla_idata;
72 	unsigned short	ifi_type;
73 	int		ifi_index;
74 	uint32_t	ifla_link;
75 	uint32_t	ifla_mtu;
76 	uint32_t	ifi_flags;
77 	uint32_t	ifi_change;
78 };
79 
80 int nl_modify_ifp_generic(struct ifnet *ifp, struct nl_parsed_link *lattrs,
81     const struct nlattr_bmask *bm, struct nl_pstate *npt);
82 void nl_store_ifp_cookie(struct nl_pstate *npt, struct ifnet *ifp);
83 
84 
85 typedef int rtnl_iface_create_f(struct nl_parsed_link *lattrs,
86     const struct nlattr_bmask *bm, struct nlpcb *nlp, struct nl_pstate *npt);
87 typedef int rtnl_iface_modify_f(struct ifnet *ifp, struct nl_parsed_link *lattrs,
88     const struct nlattr_bmask *bm, struct nlpcb *nlp, struct nl_pstate *npt);
89 typedef int rtnl_iface_dump_f(struct ifnet *ifp, struct nl_writer *nw);
90 
91 struct nl_cloner {
92 	const char		*name;
93 	rtnl_iface_create_f	*create_f;
94 	rtnl_iface_modify_f	*modify_f;
95 	rtnl_iface_dump_f	*dump_f;
96 	SLIST_ENTRY(nl_cloner)	next;
97 };
98 
99 extern struct nl_cloner	generic_cloner;
100 
101 void rtnl_ifaces_init(void);
102 void rtnl_ifaces_destroy(void);
103 void rtnl_iface_add_cloner(struct nl_cloner *cloner);
104 void rtnl_iface_del_cloner(struct nl_cloner *cloner);
105 void rtnl_handle_ifnet_event(struct ifnet *ifp, int if_change_mask);
106 
107 /* iface_drivers.c */
108 void rtnl_iface_drivers_register(void);
109 
110 /* nexthop.c */
111 void rtnl_nexthops_init(void);
112 struct nhop_object *nl_find_nhop(uint32_t fibnum, int family,
113     uint32_t uidx, int nh_flags, int *perror);
114 int nl_set_nexthop_gw(struct nhop_object *nh, struct sockaddr *gw,
115     struct ifnet *ifp, struct nl_pstate *npt);
116 
117 
118 #endif
119