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"
35 #include "opt_mpath.h"
37 #include <sys/param.h>
38 #include <sys/systm.h>
40 #include <sys/rmlock.h>
41 #include <sys/malloc.h>
43 #include <sys/socket.h>
44 #include <sys/sysctl.h>
45 #include <sys/kernel.h>
48 #include <net/if_var.h>
49 #include <net/if_dl.h>
50 #include <net/route.h>
51 #include <net/route_var.h>
52 #include <net/route/nhop.h>
53 #include <net/route/shared.h>
57 #include <net/radix_mpath.h>
60 #include <netinet/in.h>
61 #include <netinet/in_var.h>
62 #include <netinet/in_fib.h>
65 static void fib4_rte_to_nh_basic(struct nhop_object *nh, struct in_addr dst,
66 uint32_t flags, struct nhop4_basic *pnh4);
67 static void fib4_rte_to_nh_extended(struct nhop_object *nh, struct in_addr dst,
68 uint32_t flags, struct nhop4_extended *pnh4);
70 #define RNTORT(p) ((struct rtentry *)(p))
73 fib4_rte_to_nh_basic(struct nhop_object *nh, struct in_addr dst,
74 uint32_t flags, struct nhop4_basic *pnh4)
77 if ((flags & NHR_IFAIF) != 0)
78 pnh4->nh_ifp = nh->nh_ifa->ifa_ifp;
80 pnh4->nh_ifp = nh->nh_ifp;
81 pnh4->nh_mtu = nh->nh_mtu;
82 if (nh->nh_flags & NHF_GATEWAY)
83 pnh4->nh_addr = nh->gw4_sa.sin_addr;
87 pnh4->nh_flags = nh->nh_flags;
88 /* TODO: Handle RTF_BROADCAST here */
92 fib4_rte_to_nh_extended(struct nhop_object *nh, struct in_addr dst,
93 uint32_t flags, struct nhop4_extended *pnh4)
96 if ((flags & NHR_IFAIF) != 0)
97 pnh4->nh_ifp = nh->nh_ifa->ifa_ifp;
99 pnh4->nh_ifp = nh->nh_ifp;
100 pnh4->nh_mtu = nh->nh_mtu;
101 if (nh->nh_flags & NHF_GATEWAY)
102 pnh4->nh_addr = nh->gw4_sa.sin_addr;
106 pnh4->nh_flags = nh->nh_flags;
107 pnh4->nh_ia = ifatoia(nh->nh_ifa);
108 pnh4->nh_src = IA_SIN(pnh4->nh_ia)->sin_addr;
112 * Performs IPv4 route table lookup on @dst. Returns 0 on success.
113 * Stores nexthop info provided @pnh4 structure.
115 * - nh_ifp cannot be safely dereferenced
116 * - nh_ifp represents logical transmit interface (rt_ifp) (e.g. if
117 * looking up address on interface "ix0" pointer to "lo0" interface
118 * will be returned instead of "ix0")
119 * - nh_ifp represents "address" interface if NHR_IFAIF flag is passed
120 * - howewer mtu from "transmit" interface will be returned.
123 fib4_lookup_nh_basic(uint32_t fibnum, struct in_addr dst, uint32_t flags,
124 uint32_t flowid, struct nhop4_basic *pnh4)
128 struct radix_node *rn;
129 struct sockaddr_in sin;
130 struct nhop_object *nh;
132 KASSERT((fibnum < rt_numfibs), ("fib4_lookup_nh_basic: bad fibnum"));
133 rh = rt_tables_get_rnh(fibnum, AF_INET);
137 /* Prepare lookup key */
138 memset(&sin, 0, sizeof(sin));
139 sin.sin_len = sizeof(struct sockaddr_in);
143 rn = rh->rnh_matchaddr((void *)&sin, &rh->head);
144 if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
145 nh = RNTORT(rn)->rt_nhop;
146 /* Ensure route & ifp is UP */
147 if (RT_LINK_IS_UP(nh->nh_ifp)) {
148 fib4_rte_to_nh_basic(nh, dst, flags, pnh4);
160 * Performs IPv4 route table lookup on @dst. Returns 0 on success.
161 * Stores extende nexthop info provided @pnh4 structure.
163 * - nh_ifp cannot be safely dereferenced unless NHR_REF is specified.
164 * - in that case you need to call fib4_free_nh_ext()
165 * - nh_ifp represents logical transmit interface (rt_ifp) (e.g. if
166 * looking up address of interface "ix0" pointer to "lo0" interface
167 * will be returned instead of "ix0")
168 * - nh_ifp represents "address" interface if NHR_IFAIF flag is passed
169 * - howewer mtu from "transmit" interface will be returned.
172 fib4_lookup_nh_ext(uint32_t fibnum, struct in_addr dst, uint32_t flags,
173 uint32_t flowid, struct nhop4_extended *pnh4)
177 struct radix_node *rn;
178 struct sockaddr_in sin;
180 struct nhop_object *nh;
182 KASSERT((fibnum < rt_numfibs), ("fib4_lookup_nh_ext: bad fibnum"));
183 rh = rt_tables_get_rnh(fibnum, AF_INET);
187 /* Prepare lookup key */
188 memset(&sin, 0, sizeof(sin));
189 sin.sin_len = sizeof(struct sockaddr_in);
193 rn = rh->rnh_matchaddr((void *)&sin, &rh->head);
194 if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
197 rte = rt_mpath_select(rte, flowid);
204 /* Ensure route & ifp is UP */
205 if (RT_LINK_IS_UP(nh->nh_ifp)) {
206 fib4_rte_to_nh_extended(nh, dst, flags, pnh4);
207 if ((flags & NHR_REF) != 0) {
208 /* TODO: lwref on egress ifp's ? */
221 fib4_free_nh_ext(uint32_t fibnum, struct nhop4_extended *pnh4)
227 * Looks up path in fib @fibnum specified by @dst.
228 * Returns path nexthop on success. Nexthop is safe to use
229 * within the current network epoch. If longer lifetime is required,
230 * one needs to pass NHR_REF as a flag. This will return referenced
234 fib4_lookup(uint32_t fibnum, struct in_addr dst, uint32_t scopeid,
235 uint32_t flags, uint32_t flowid)
239 struct radix_node *rn;
241 struct nhop_object *nh;
243 KASSERT((fibnum < rt_numfibs), ("fib4_lookup: bad fibnum"));
244 rh = rt_tables_get_rnh(fibnum, AF_INET);
248 /* Prepare lookup key */
249 struct sockaddr_in sin4;
250 memset(&sin4, 0, sizeof(sin4));
251 sin4.sin_family = AF_INET;
252 sin4.sin_len = sizeof(struct sockaddr_in);
257 rn = rh->rnh_matchaddr((void *)&sin4, &rh->head);
258 if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
261 if (rt_mpath_next(rt) != NULL)
262 rt = rt_mpath_selectrte(rt, flowid);
265 /* Ensure route & ifp is UP */
266 if (RT_LINK_IS_UP(nh->nh_ifp)) {
275 RTSTAT_INC(rts_unreach);
280 check_urpf(const struct nhop_object *nh, uint32_t flags,
281 const struct ifnet *src_if)
284 if (src_if != NULL && nh->nh_aifp == src_if) {
287 if (src_if == NULL) {
288 if ((flags & NHR_NODEFAULT) == 0)
290 else if ((nh->nh_flags & NHF_DEFAULT) == 0)
299 check_urpf_mpath(struct rtentry *rt, uint32_t flags,
300 const struct ifnet *src_if)
304 if (check_urpf(rt->rt_nhop, flags, src_if) != 0)
306 rt = rt_mpath_next(rt);
314 * Performs reverse path forwarding lookup.
315 * If @src_if is non-zero, verifies that at least 1 path goes via
317 * If @src_if is zero, verifies that route exist.
318 * if @flags contains NHR_NOTDEFAULT, do not consider default route.
320 * Returns 1 if route matching conditions is found, 0 otherwise.
323 fib4_check_urpf(uint32_t fibnum, struct in_addr dst, uint32_t scopeid,
324 uint32_t flags, const struct ifnet *src_if)
328 struct radix_node *rn;
332 KASSERT((fibnum < rt_numfibs), ("fib4_check_urpf: bad fibnum"));
333 rh = rt_tables_get_rnh(fibnum, AF_INET);
337 /* Prepare lookup key */
338 struct sockaddr_in sin4;
339 memset(&sin4, 0, sizeof(sin4));
340 sin4.sin_len = sizeof(struct sockaddr_in);
344 rn = rh->rnh_matchaddr((void *)&sin4, &rh->head);
345 if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
348 ret = check_urpf_mpath(rt, flags, src_if);
350 ret = check_urpf(rt->rt_nhop, flags, src_if);