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/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>
66 /* Verify struct route compatiblity */
67 /* Assert 'struct route_in' is compatible with 'struct route' */
68 CHK_STRUCT_ROUTE_COMPAT(struct route_in, ro_dst4);
69 static void fib4_rte_to_nh_basic(struct nhop_object *nh, struct in_addr dst,
70 uint32_t flags, struct nhop4_basic *pnh4);
71 static void fib4_rte_to_nh_extended(struct nhop_object *nh, struct in_addr dst,
72 uint32_t flags, struct nhop4_extended *pnh4);
76 fib4_rte_to_nh_basic(struct nhop_object *nh, struct in_addr dst,
77 uint32_t flags, struct nhop4_basic *pnh4)
80 if ((flags & NHR_IFAIF) != 0)
81 pnh4->nh_ifp = nh->nh_ifa->ifa_ifp;
83 pnh4->nh_ifp = nh->nh_ifp;
84 pnh4->nh_mtu = nh->nh_mtu;
85 if (nh->nh_flags & NHF_GATEWAY)
86 pnh4->nh_addr = nh->gw4_sa.sin_addr;
90 pnh4->nh_flags = nh->nh_flags;
91 /* TODO: Handle RTF_BROADCAST here */
95 fib4_rte_to_nh_extended(struct nhop_object *nh, struct in_addr dst,
96 uint32_t flags, struct nhop4_extended *pnh4)
99 if ((flags & NHR_IFAIF) != 0)
100 pnh4->nh_ifp = nh->nh_ifa->ifa_ifp;
102 pnh4->nh_ifp = nh->nh_ifp;
103 pnh4->nh_mtu = nh->nh_mtu;
104 if (nh->nh_flags & NHF_GATEWAY)
105 pnh4->nh_addr = nh->gw4_sa.sin_addr;
109 pnh4->nh_flags = nh->nh_flags;
110 pnh4->nh_ia = ifatoia(nh->nh_ifa);
111 pnh4->nh_src = IA_SIN(pnh4->nh_ia)->sin_addr;
115 * Performs IPv4 route table lookup on @dst. Returns 0 on success.
116 * Stores nexthop info provided @pnh4 structure.
118 * - nh_ifp cannot be safely dereferenced
119 * - nh_ifp represents logical transmit interface (rt_ifp) (e.g. if
120 * looking up address on interface "ix0" pointer to "lo0" interface
121 * will be returned instead of "ix0")
122 * - nh_ifp represents "address" interface if NHR_IFAIF flag is passed
123 * - howewer mtu from "transmit" interface will be returned.
126 fib4_lookup_nh_basic(uint32_t fibnum, struct in_addr dst, uint32_t flags,
127 uint32_t flowid, struct nhop4_basic *pnh4)
131 struct radix_node *rn;
132 struct sockaddr_in sin;
133 struct nhop_object *nh;
135 KASSERT((fibnum < rt_numfibs), ("fib4_lookup_nh_basic: bad fibnum"));
136 rh = rt_tables_get_rnh(fibnum, AF_INET);
140 /* Prepare lookup key */
141 memset(&sin, 0, sizeof(sin));
142 sin.sin_len = sizeof(struct sockaddr_in);
146 rn = rh->rnh_matchaddr((void *)&sin, &rh->head);
147 if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
148 nh = RNTORT(rn)->rt_nhop;
149 /* Ensure route & ifp is UP */
150 if (RT_LINK_IS_UP(nh->nh_ifp)) {
151 fib4_rte_to_nh_basic(nh, dst, flags, pnh4);
163 * Performs IPv4 route table lookup on @dst. Returns 0 on success.
164 * Stores extende nexthop info provided @pnh4 structure.
166 * - nh_ifp cannot be safely dereferenced unless NHR_REF is specified.
167 * - in that case you need to call fib4_free_nh_ext()
168 * - nh_ifp represents logical transmit interface (rt_ifp) (e.g. if
169 * looking up address of interface "ix0" pointer to "lo0" interface
170 * will be returned instead of "ix0")
171 * - nh_ifp represents "address" interface if NHR_IFAIF flag is passed
172 * - howewer mtu from "transmit" interface will be returned.
175 fib4_lookup_nh_ext(uint32_t fibnum, struct in_addr dst, uint32_t flags,
176 uint32_t flowid, struct nhop4_extended *pnh4)
180 struct radix_node *rn;
181 struct sockaddr_in sin;
183 struct nhop_object *nh;
185 KASSERT((fibnum < rt_numfibs), ("fib4_lookup_nh_ext: bad fibnum"));
186 rh = rt_tables_get_rnh(fibnum, AF_INET);
190 /* Prepare lookup key */
191 memset(&sin, 0, sizeof(sin));
192 sin.sin_len = sizeof(struct sockaddr_in);
196 rn = rh->rnh_matchaddr((void *)&sin, &rh->head);
197 if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
200 rte = rt_mpath_select(rte, flowid);
207 /* Ensure route & ifp is UP */
208 if (RT_LINK_IS_UP(nh->nh_ifp)) {
209 fib4_rte_to_nh_extended(nh, dst, flags, pnh4);
210 if ((flags & NHR_REF) != 0) {
211 /* TODO: lwref on egress ifp's ? */
224 fib4_free_nh_ext(uint32_t fibnum, struct nhop4_extended *pnh4)
230 * Looks up path in fib @fibnum specified by @dst.
231 * Returns path nexthop on success. Nexthop is safe to use
232 * within the current network epoch. If longer lifetime is required,
233 * one needs to pass NHR_REF as a flag. This will return referenced
237 fib4_lookup(uint32_t fibnum, struct in_addr dst, uint32_t scopeid,
238 uint32_t flags, uint32_t flowid)
242 struct radix_node *rn;
244 struct nhop_object *nh;
246 KASSERT((fibnum < rt_numfibs), ("fib4_lookup: bad fibnum"));
247 rh = rt_tables_get_rnh(fibnum, AF_INET);
251 /* Prepare lookup key */
252 struct sockaddr_in sin4;
253 memset(&sin4, 0, sizeof(sin4));
254 sin4.sin_family = AF_INET;
255 sin4.sin_len = sizeof(struct sockaddr_in);
260 rn = rh->rnh_matchaddr((void *)&sin4, &rh->head);
261 if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
264 if (rt_mpath_next(rt) != NULL)
265 rt = rt_mpath_selectrte(rt, flowid);
268 /* Ensure route & ifp is UP */
269 if (RT_LINK_IS_UP(nh->nh_ifp)) {
278 RTSTAT_INC(rts_unreach);
283 check_urpf(const struct nhop_object *nh, uint32_t flags,
284 const struct ifnet *src_if)
287 if (src_if != NULL && nh->nh_aifp == src_if) {
290 if (src_if == NULL) {
291 if ((flags & NHR_NODEFAULT) == 0)
293 else if ((nh->nh_flags & NHF_DEFAULT) == 0)
302 check_urpf_mpath(struct rtentry *rt, uint32_t flags,
303 const struct ifnet *src_if)
307 if (check_urpf(rt->rt_nhop, flags, src_if) != 0)
309 rt = rt_mpath_next(rt);
317 * Performs reverse path forwarding lookup.
318 * If @src_if is non-zero, verifies that at least 1 path goes via
320 * If @src_if is zero, verifies that route exist.
321 * if @flags contains NHR_NOTDEFAULT, do not consider default route.
323 * Returns 1 if route matching conditions is found, 0 otherwise.
326 fib4_check_urpf(uint32_t fibnum, struct in_addr dst, uint32_t scopeid,
327 uint32_t flags, const struct ifnet *src_if)
331 struct radix_node *rn;
335 KASSERT((fibnum < rt_numfibs), ("fib4_check_urpf: bad fibnum"));
336 rh = rt_tables_get_rnh(fibnum, AF_INET);
340 /* Prepare lookup key */
341 struct sockaddr_in sin4;
342 memset(&sin4, 0, sizeof(sin4));
343 sin4.sin_len = sizeof(struct sockaddr_in);
347 rn = rh->rnh_matchaddr((void *)&sin4, &rh->head);
348 if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
351 ret = check_urpf_mpath(rt, flags, src_if);
353 ret = check_urpf(rt->rt_nhop, flags, src_if);
364 fib4_lookup_debugnet(uint32_t fibnum, struct in_addr dst, uint32_t scopeid,
368 struct radix_node *rn;
370 struct nhop_object *nh;
372 KASSERT((fibnum < rt_numfibs), ("fib4_lookup_debugnet: bad fibnum"));
373 rh = rt_tables_get_rnh(fibnum, AF_INET);
377 /* Prepare lookup key */
378 struct sockaddr_in sin4;
379 memset(&sin4, 0, sizeof(sin4));
380 sin4.sin_family = AF_INET;
381 sin4.sin_len = sizeof(struct sockaddr_in);
385 /* unlocked lookup */
386 rn = rh->rnh_matchaddr((void *)&sin4, &rh->head);
387 if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
390 if (rt_mpath_next(rt) != NULL)
391 rt = rt_mpath_selectrte(rt, 0);
394 /* Ensure route & ifp is UP */
395 if (RT_LINK_IS_UP(nh->nh_ifp)) {