3 * Alexander V. Chernikov <melifaro@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
34 #include "opt_route.h"
36 #include <sys/param.h>
37 #include <sys/systm.h>
39 #include <sys/rmlock.h>
40 #include <sys/malloc.h>
42 #include <sys/socket.h>
43 #include <sys/sysctl.h>
44 #include <sys/kernel.h>
47 #include <net/if_var.h>
48 #include <net/if_dl.h>
49 #include <net/route.h>
50 #include <net/route/route_ctl.h>
51 #include <net/route/route_var.h>
52 #include <net/route/fib_algo.h>
53 #include <net/route/nhop.h>
54 #include <net/toeplitz.h>
57 #include <netinet/in.h>
58 #include <netinet/in_var.h>
59 #include <netinet/in_fib.h>
63 /* Verify struct route compatiblity */
64 /* Assert 'struct route_in' is compatible with 'struct route' */
65 CHK_STRUCT_ROUTE_COMPAT(struct route_in, ro_dst4);
68 VNET_DEFINE(struct fib_dp *, inet_dp);
72 struct _hash_5tuple_ipv4 {
75 unsigned short src_port;
76 unsigned short dst_port;
80 _Static_assert(sizeof(struct _hash_5tuple_ipv4) == 16,
81 "_hash_5tuple_ipv4 size is wrong");
84 fib4_calc_software_hash(struct in_addr src, struct in_addr dst,
85 unsigned short src_port, unsigned short dst_port, char proto,
88 struct _hash_5tuple_ipv4 data;
92 data.src_port = src_port;
93 data.dst_port = dst_port;
95 data.spare[0] = data.spare[1] = data.spare[2] = 0;
97 *phashtype = M_HASHTYPE_OPAQUE;
99 return (toeplitz_hash(MPATH_ENTROPY_KEY_LEN, mpath_entropy_key,
100 sizeof(data), (uint8_t *)&data));
105 * Looks up path in fib @fibnum specified by @dst.
106 * Returns path nexthop on success. Nexthop is safe to use
107 * within the current network epoch. If longer lifetime is required,
108 * one needs to pass NHR_REF as a flag. This will return referenced
113 fib4_lookup(uint32_t fibnum, struct in_addr dst, uint32_t scopeid,
114 uint32_t flags, uint32_t flowid)
116 struct nhop_object *nh;
117 struct fib_dp *dp = &V_inet_dp[fibnum];
118 struct flm_lookup_key key = {.addr4 = dst };
120 nh = dp->f(dp->arg, key, scopeid);
122 nh = nhop_select(nh, flowid);
123 /* Ensure route & ifp is UP */
124 if (RT_LINK_IS_UP(nh->nh_ifp)) {
130 RTSTAT_INC(rts_unreach);
135 fib4_lookup(uint32_t fibnum, struct in_addr dst, uint32_t scopeid,
136 uint32_t flags, uint32_t flowid)
140 struct radix_node *rn;
141 struct nhop_object *nh;
143 KASSERT((fibnum < rt_numfibs), ("fib4_lookup: bad fibnum"));
144 rh = rt_tables_get_rnh(fibnum, AF_INET);
148 /* Prepare lookup key */
149 struct sockaddr_in sin4 = {
150 .sin_family = AF_INET,
151 .sin_len = sizeof(struct sockaddr_in),
157 rn = rh->rnh_matchaddr((void *)&sin4, &rh->head);
158 if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
159 nh = nhop_select((RNTORT(rn))->rt_nhop, flowid);
160 /* Ensure route & ifp is UP */
161 if (RT_LINK_IS_UP(nh->nh_ifp)) {
170 RTSTAT_INC(rts_unreach);
176 check_urpf_nhop(const struct nhop_object *nh, uint32_t flags,
177 const struct ifnet *src_if)
180 if (src_if != NULL && nh->nh_aifp == src_if) {
183 if (src_if == NULL) {
184 if ((flags & NHR_NODEFAULT) == 0)
186 else if ((nh->nh_flags & NHF_DEFAULT) == 0)
194 check_urpf(struct nhop_object *nh, uint32_t flags,
195 const struct ifnet *src_if)
198 if (NH_IS_NHGRP(nh)) {
199 const struct weightened_nhop *wn;
201 wn = nhgrp_get_nhops((struct nhgrp_object *)nh, &num_nhops);
202 for (int i = 0; i < num_nhops; i++) {
203 if (check_urpf_nhop(wn[i].nh, flags, src_if) != 0)
209 return (check_urpf_nhop(nh, flags, src_if));
213 static struct nhop_object *
214 lookup_nhop(uint32_t fibnum, struct in_addr dst, uint32_t scopeid)
218 struct radix_node *rn;
219 struct nhop_object *nh;
221 KASSERT((fibnum < rt_numfibs), ("fib4_check_urpf: bad fibnum"));
222 rh = rt_tables_get_rnh(fibnum, AF_INET);
226 /* Prepare lookup key */
227 struct sockaddr_in sin4;
228 memset(&sin4, 0, sizeof(sin4));
229 sin4.sin_len = sizeof(struct sockaddr_in);
234 rn = rh->rnh_matchaddr((void *)&sin4, &rh->head);
235 if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0))
236 nh = RNTORT(rn)->rt_nhop;
244 * Performs reverse path forwarding lookup.
245 * If @src_if is non-zero, verifies that at least 1 path goes via
247 * If @src_if is zero, verifies that route exist.
248 * if @flags contains NHR_NOTDEFAULT, do not consider default route.
250 * Returns 1 if route matching conditions is found, 0 otherwise.
253 fib4_check_urpf(uint32_t fibnum, struct in_addr dst, uint32_t scopeid,
254 uint32_t flags, const struct ifnet *src_if)
256 struct nhop_object *nh;
258 struct fib_dp *dp = &V_inet_dp[fibnum];
259 struct flm_lookup_key key = {.addr4 = dst };
261 nh = dp->f(dp->arg, key, scopeid);
263 nh = lookup_nhop(fibnum, dst, scopeid);
266 return (check_urpf(nh, flags, src_if));
272 * Function returning prefix match data along with the nexthop data.
273 * Intended to be used by the control plane code.
275 * NHR_UNLOCKED: do not lock radix during lookup.
276 * Returns pointer to rtentry and raw nexthop in @rnd. Both rtentry
277 * and nexthop are safe to use within current epoch. Note:
278 * Note: rnd_nhop can actually be the nexthop group.
281 fib4_lookup_rt(uint32_t fibnum, struct in_addr dst, uint32_t scopeid,
282 uint32_t flags, struct route_nhop_data *rnd)
286 struct radix_node *rn;
289 KASSERT((fibnum < rt_numfibs), ("fib4_lookup_rt: bad fibnum"));
290 rh = rt_tables_get_rnh(fibnum, AF_INET);
294 /* Prepare lookup key */
295 struct sockaddr_in sin4 = {
296 .sin_family = AF_INET,
297 .sin_len = sizeof(struct sockaddr_in),
302 if (!(flags & NHR_UNLOCKED))
304 rn = rh->rnh_matchaddr((void *)&sin4, &rh->head);
305 if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
306 rt = (struct rtentry *)rn;
307 rnd->rnd_nhop = rt->rt_nhop;
308 rnd->rnd_weight = rt->rt_weight;
310 if (!(flags & NHR_UNLOCKED))
317 fib4_lookup_debugnet(uint32_t fibnum, struct in_addr dst, uint32_t scopeid,
321 struct route_nhop_data rnd;
323 rt = fib4_lookup_rt(fibnum, dst, scopeid, NHR_UNLOCKED, &rnd);
325 struct nhop_object *nh = nhop_select(rnd.rnd_nhop, 0);
326 /* Ensure route & ifp is UP */
327 if (RT_LINK_IS_UP(nh->nh_ifp))