master
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2020 Alexander V. Chernikov
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 header file contains public functions and structures used for
30 * routing table manipulations.
31 */
32
33#ifndef _NET_ROUTE_ROUTE_CTL_H_
34#define _NET_ROUTE_ROUTE_CTL_H_
35
36struct rib_head *rt_tables_get_rnh_safe(uint32_t table, sa_family_t family);
37
38struct rib_cmd_info {
39 uint8_t rc_cmd; /* RTM_ADD|RTM_DEL|RTM_CHANGE */
40 uint8_t spare[3];
41 uint32_t rc_nh_weight; /* new nhop weight */
42 struct rtentry *rc_rt; /* Target entry */
43 struct nhop_object *rc_nh_old; /* Target nhop OR mpath */
44 struct nhop_object *rc_nh_new; /* Target nhop OR mpath */
45};
46
47struct route_nhop_data {
48 union {
49 struct nhop_object *rnd_nhop;
50 struct nhgrp_object *rnd_nhgrp;
51 };
52 uint32_t rnd_weight;
53};
54
55int rib_add_route_px(uint32_t fibnum, struct sockaddr *dst, int plen,
56 struct route_nhop_data *rnd, int op_flags, struct rib_cmd_info *rc);
57int rib_del_route_px(uint32_t fibnum, struct sockaddr *dst, int plen,
58 rib_filter_f_t *filter_func, void *filter_arg, int op_flags,
59 struct rib_cmd_info *rc);
60int rib_del_route_px_gw(uint32_t fibnum, struct sockaddr *dst, int plen,
61 const struct sockaddr *gw, int op_flags, struct rib_cmd_info *rc);
62
63/* operation flags */
64#define RTM_F_CREATE 0x01
65#define RTM_F_EXCL 0x02
66#define RTM_F_REPLACE 0x04
67#define RTM_F_APPEND 0x08
68#define RTM_F_FORCE 0x10
69
70int rib_add_route(uint32_t fibnum, struct rt_addrinfo *info,
71 struct rib_cmd_info *rc);
72int rib_del_route(uint32_t fibnum, struct rt_addrinfo *info,
73 struct rib_cmd_info *rc);
74int rib_change_route(uint32_t fibnum, struct rt_addrinfo *info,
75 struct rib_cmd_info *rc);
76int rib_action(uint32_t fibnum, int action, struct rt_addrinfo *info,
77 struct rib_cmd_info *rc);
78int rib_match_gw(const struct rtentry *rt, const struct nhop_object *nh,
79 void *_data);
80int rib_handle_ifaddr_info(uint32_t fibnum, int cmd, struct rt_addrinfo *info);
81
82int rib_add_default_route(uint32_t fibnum, int family, struct ifnet *ifp,
83 struct sockaddr *gw, struct rib_cmd_info *rc);
84
85typedef void route_notification_t(const struct rib_cmd_info *rc, void *);
86void rib_decompose_notification(const struct rib_cmd_info *rc,
87 route_notification_t *cb, void *cbdata);
88
89int rib_add_redirect(u_int fibnum, struct sockaddr *dst,
90 struct sockaddr *gateway, struct sockaddr *author, struct ifnet *ifp,
91 int flags, int expire_sec);
92
93/* common flags for the functions below */
94#define RIB_FLAG_WLOCK 0x01 /* Need exclusive rnh lock */
95#define RIB_FLAG_LOCKED 0x02 /* Do not explicitly acquire rnh lock */
96
97enum rib_walk_hook {
98 RIB_WALK_HOOK_PRE, /* Hook is called before iteration */
99 RIB_WALK_HOOK_POST, /* Hook is called after iteration */
100};
101typedef int rib_walktree_f_t(struct rtentry *, void *);
102typedef void rib_walk_hook_f_t(struct rib_head *rnh, enum rib_walk_hook stage,
103 void *arg);
104void rib_walk(uint32_t fibnum, int af, bool wlock, rib_walktree_f_t *wa_f,
105 void *arg);
106void rib_walk_ext(uint32_t fibnum, int af, bool wlock, rib_walktree_f_t *wa_f,
107 rib_walk_hook_f_t *hook_f, void *arg);
108void rib_walk_ext_internal(struct rib_head *rnh, bool wlock,
109 rib_walktree_f_t *wa_f, rib_walk_hook_f_t *hook_f, void *arg);
110void rib_walk_ext_locked(struct rib_head *rnh, rib_walktree_f_t *wa_f,
111 rib_walk_hook_f_t *hook_f, void *arg);
112void rib_walk_from(uint32_t fibnum, int family, uint32_t flags, struct sockaddr *prefix,
113 struct sockaddr *mask, rib_walktree_f_t *wa_f, void *arg);
114
115void rib_walk_del(u_int fibnum, int family, rib_filter_f_t *filter_f,
116 void *filter_arg, bool report);
117
118void rib_foreach_table_walk(int family, bool wlock, rib_walktree_f_t *wa_f,
119 rib_walk_hook_f_t *hook_f, void *arg);
120void rib_foreach_table_walk_del(int family, rib_filter_f_t *filter_f, void *arg);
121
122struct nhop_object;
123struct nhgrp_object;
124struct ucred;
125
126const struct rtentry *
127rib_lookup_prefix_plen(struct rib_head *rnh, struct sockaddr *dst, int plen,
128 struct route_nhop_data *rnd);
129
130/* rtentry accessors */
131bool rt_is_host(const struct rtentry *rt);
132sa_family_t rt_get_family(const struct rtentry *);
133struct nhop_object *rt_get_raw_nhop(const struct rtentry *rt);
134void rt_get_rnd(const struct rtentry *rt, struct route_nhop_data *rnd);
135bool rt_is_exportable(const struct rtentry *rt, struct ucred *cred);
136#ifdef INET
137struct in_addr;
138void rt_get_inet_prefix_plen(const struct rtentry *rt, struct in_addr *paddr,
139 int *plen, uint32_t *pscopeid);
140void rt_get_inet_prefix_pmask(const struct rtentry *rt, struct in_addr *paddr,
141 struct in_addr *pmask, uint32_t *pscopeid);
142struct rtentry *rt_get_inet_parent(uint32_t fibnum, struct in_addr addr, int plen);
143#endif
144#ifdef INET6
145struct in6_addr;
146void rt_get_inet6_prefix_plen(const struct rtentry *rt, struct in6_addr *paddr,
147 int *plen, uint32_t *pscopeid);
148void rt_get_inet6_prefix_pmask(const struct rtentry *rt, struct in6_addr *paddr,
149 struct in6_addr *pmask, uint32_t *pscopeid);
150struct rtentry *rt_get_inet6_parent(uint32_t fibnum, const struct in6_addr *paddr,
151 int plen);
152
153struct in6_addr;
154void ip6_writemask(struct in6_addr *addr6, uint8_t mask);
155#endif
156
157/* Nexthops */
158uint32_t nhops_get_count(struct rib_head *rh);
159
160struct nhop_priv;
161struct nhop_iter {
162 uint32_t fibnum;
163 uint8_t family;
164 struct rib_head *rh;
165 int _i;
166 struct nhop_priv *_next;
167};
168
169struct nhop_object *nhops_iter_start(struct nhop_iter *iter);
170struct nhop_object *nhops_iter_next(struct nhop_iter *iter);
171void nhops_iter_stop(struct nhop_iter *iter);
172
173/* Multipath */
174struct weightened_nhop;
175
176const struct weightened_nhop *nhgrp_get_nhops(const struct nhgrp_object *nhg,
177 uint32_t *pnum_nhops);
178uint32_t nhgrp_get_count(struct rib_head *rh);
179int nhgrp_get_group(struct rib_head *rh, struct weightened_nhop *wn, int num_nhops,
180 uint32_t uidx, struct nhgrp_object **pnhg);
181
182/* Route subscriptions */
183enum rib_subscription_type {
184 RIB_NOTIFY_IMMEDIATE,
185 RIB_NOTIFY_DELAYED
186};
187
188struct rib_subscription;
189typedef void rib_subscription_cb_t(struct rib_head *rnh, struct rib_cmd_info *rc,
190 void *arg);
191
192struct rib_subscription *rib_subscribe(uint32_t fibnum, int family,
193 rib_subscription_cb_t *f, void *arg, enum rib_subscription_type type,
194 bool waitok);
195struct rib_subscription *rib_subscribe_internal(struct rib_head *rnh,
196 rib_subscription_cb_t *f, void *arg, enum rib_subscription_type type,
197 bool waitok);
198struct rib_subscription *rib_subscribe_locked(struct rib_head *rnh,
199 rib_subscription_cb_t *f, void *arg, enum rib_subscription_type type);
200void rib_unsubscribe(struct rib_subscription *rs);
201void rib_unsubscribe_locked(struct rib_subscription *rs);
202void rib_notify(struct rib_head *rnh, enum rib_subscription_type type,
203 struct rib_cmd_info *rc);
204
205/* Event bridge */
206typedef void route_event_f(uint32_t fibnum, const struct rib_cmd_info *rc);
207typedef void ifmsg_event_f(struct ifnet *ifp, int if_flags_mask);
208struct rtbridge{
209 route_event_f *route_f;
210 ifmsg_event_f *ifmsg_f;
211};
212extern struct rtbridge *rtsock_callback_p;
213extern struct rtbridge *netlink_callback_p;
214#endif