2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2020 Alexander V. Chernikov
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
31 * This header file contains public functions and structures used for
32 * routing table manipulations.
35 #ifndef _NET_ROUTE_ROUTE_CTL_H_
36 #define _NET_ROUTE_ROUTE_CTL_H_
39 uint8_t rc_cmd; /* RTM_ADD|RTM_DEL|RTM_CHANGE */
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 */
47 struct route_nhop_data {
49 struct nhop_object *rnd_nhop;
50 struct nhgrp_object *rnd_nhgrp;
55 int 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);
57 int 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);
60 int 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);
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
70 int rib_add_route(uint32_t fibnum, struct rt_addrinfo *info,
71 struct rib_cmd_info *rc);
72 int rib_del_route(uint32_t fibnum, struct rt_addrinfo *info,
73 struct rib_cmd_info *rc);
74 int rib_change_route(uint32_t fibnum, struct rt_addrinfo *info,
75 struct rib_cmd_info *rc);
76 int rib_action(uint32_t fibnum, int action, struct rt_addrinfo *info,
77 struct rib_cmd_info *rc);
78 int rib_match_gw(const struct rtentry *rt, const struct nhop_object *nh,
80 int rib_handle_ifaddr_info(uint32_t fibnum, int cmd, struct rt_addrinfo *info);
82 int rib_add_default_route(uint32_t fibnum, int family, struct ifnet *ifp,
83 struct sockaddr *gw, struct rib_cmd_info *rc);
85 typedef void route_notification_t(const struct rib_cmd_info *rc, void *);
86 void rib_decompose_notification(const struct rib_cmd_info *rc,
87 route_notification_t *cb, void *cbdata);
89 int 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);
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 */
98 RIB_WALK_HOOK_PRE, /* Hook is called before iteration */
99 RIB_WALK_HOOK_POST, /* Hook is called after iteration */
101 typedef int rib_walktree_f_t(struct rtentry *, void *);
102 typedef void rib_walk_hook_f_t(struct rib_head *rnh, enum rib_walk_hook stage,
104 void rib_walk(uint32_t fibnum, int af, bool wlock, rib_walktree_f_t *wa_f,
106 void 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);
108 void 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);
110 void rib_walk_ext_locked(struct rib_head *rnh, rib_walktree_f_t *wa_f,
111 rib_walk_hook_f_t *hook_f, void *arg);
112 void 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);
115 void rib_walk_del(u_int fibnum, int family, rib_filter_f_t *filter_f,
116 void *filter_arg, bool report);
118 void rib_foreach_table_walk(int family, bool wlock, rib_walktree_f_t *wa_f,
119 rib_walk_hook_f_t *hook_f, void *arg);
120 void rib_foreach_table_walk_del(int family, rib_filter_f_t *filter_f, void *arg);
125 const struct rtentry *rib_lookup_prefix(uint32_t fibnum, int family,
126 const struct sockaddr *dst, const struct sockaddr *netmask,
127 struct route_nhop_data *rnd);
128 const struct rtentry *rib_lookup_lpm(uint32_t fibnum, int family,
129 const struct sockaddr *dst, struct route_nhop_data *rnd);
131 /* rtentry accessors */
132 bool rt_is_host(const struct rtentry *rt);
133 sa_family_t rt_get_family(const struct rtentry *);
134 struct nhop_object *rt_get_raw_nhop(const struct rtentry *rt);
135 void rt_get_rnd(const struct rtentry *rt, struct route_nhop_data *rnd);
138 void rt_get_inet_prefix_plen(const struct rtentry *rt, struct in_addr *paddr,
139 int *plen, uint32_t *pscopeid);
140 void rt_get_inet_prefix_pmask(const struct rtentry *rt, struct in_addr *paddr,
141 struct in_addr *pmask, uint32_t *pscopeid);
142 struct rtentry *rt_get_inet_parent(uint32_t fibnum, struct in_addr addr, int plen);
146 void rt_get_inet6_prefix_plen(const struct rtentry *rt, struct in6_addr *paddr,
147 int *plen, uint32_t *pscopeid);
148 void rt_get_inet6_prefix_pmask(const struct rtentry *rt, struct in6_addr *paddr,
149 struct in6_addr *pmask, uint32_t *pscopeid);
150 struct rtentry *rt_get_inet6_parent(uint32_t fibnum, const struct in6_addr *paddr,
154 void ip6_writemask(struct in6_addr *addr6, uint8_t mask);
158 uint32_t nhops_get_count(struct rib_head *rh);
161 struct weightened_nhop;
163 const struct weightened_nhop *nhgrp_get_nhops(const struct nhgrp_object *nhg,
164 uint32_t *pnum_nhops);
165 uint32_t nhgrp_get_count(struct rib_head *rh);
166 int nhgrp_get_group(struct rib_head *rh, struct weightened_nhop *wn, int num_nhops,
167 uint32_t uidx, struct nhgrp_object **pnhg);
169 /* Route subscriptions */
170 enum rib_subscription_type {
171 RIB_NOTIFY_IMMEDIATE,
175 struct rib_subscription;
176 typedef void rib_subscription_cb_t(struct rib_head *rnh, struct rib_cmd_info *rc,
179 struct rib_subscription *rib_subscribe(uint32_t fibnum, int family,
180 rib_subscription_cb_t *f, void *arg, enum rib_subscription_type type,
182 struct rib_subscription *rib_subscribe_internal(struct rib_head *rnh,
183 rib_subscription_cb_t *f, void *arg, enum rib_subscription_type type,
185 struct rib_subscription *rib_subscribe_locked(struct rib_head *rnh,
186 rib_subscription_cb_t *f, void *arg, enum rib_subscription_type type);
187 void rib_unsubscribe(struct rib_subscription *rs);
188 void rib_unsubscribe_locked(struct rib_subscription *rs);
189 void rib_notify(struct rib_head *rnh, enum rib_subscription_type type,
190 struct rib_cmd_info *rc);
193 typedef void route_event_f(uint32_t fibnum, const struct rib_cmd_info *rc);
194 typedef void ifmsg_event_f(struct ifnet *ifp, int if_flags_mask);
196 route_event_f *route_f;
197 ifmsg_event_f *ifmsg_f;
199 extern struct rtbridge *rtsock_callback_p;
200 extern struct rtbridge *netlink_callback_p;