xref: /freebsd/sys/netinet6/in6_fib.c (revision 2f513db7)
1 /*-
2  * Copyright (c) 2015
3  * 	Alexander V. Chernikov <melifaro@FreeBSD.org>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
16  *
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
27  * SUCH DAMAGE.
28  */
29 
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 
33 #include "opt_inet.h"
34 #include "opt_inet6.h"
35 #include "opt_route.h"
36 #include "opt_mpath.h"
37 
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/lock.h>
41 #include <sys/rmlock.h>
42 #include <sys/malloc.h>
43 #include <sys/mbuf.h>
44 #include <sys/socket.h>
45 #include <sys/sysctl.h>
46 #include <sys/kernel.h>
47 
48 #include <net/if.h>
49 #include <net/if_var.h>
50 #include <net/if_dl.h>
51 #include <net/route.h>
52 #include <net/route_var.h>
53 #include <net/vnet.h>
54 
55 #ifdef RADIX_MPATH
56 #include <net/radix_mpath.h>
57 #endif
58 
59 #include <netinet/in.h>
60 #include <netinet/in_var.h>
61 #include <netinet/ip_mroute.h>
62 #include <netinet/ip6.h>
63 #include <netinet6/in6_fib.h>
64 #include <netinet6/in6_var.h>
65 #include <netinet6/nd6.h>
66 #include <netinet6/scope6_var.h>
67 
68 #include <net/if_types.h>
69 
70 #ifdef INET6
71 static void fib6_rte_to_nh_extended(struct rtentry *rte,
72     const struct in6_addr *dst, uint32_t flags, struct nhop6_extended *pnh6);
73 static void fib6_rte_to_nh_basic(struct rtentry *rte, const struct in6_addr *dst,
74     uint32_t flags, struct nhop6_basic *pnh6);
75 static struct ifnet *fib6_get_ifaifp(struct rtentry *rte);
76 #define RNTORT(p)	((struct rtentry *)(p))
77 
78 CHK_STRUCT_ROUTE_COMPAT(struct route_in6, ro_dst);
79 
80 /*
81  * Gets real interface for the @rte.
82  * Returns rt_ifp for !IFF_LOOPBACK routers.
83  * Extracts "real" address interface from interface address
84  * loopback routes.
85  */
86 static struct ifnet *
87 fib6_get_ifaifp(struct rtentry *rte)
88 {
89 	struct ifnet *ifp;
90 	struct sockaddr_dl *sdl;
91 
92 	ifp = rte->rt_ifp;
93 	if ((ifp->if_flags & IFF_LOOPBACK) &&
94 	    rte->rt_gateway->sa_family == AF_LINK) {
95 		sdl = (struct sockaddr_dl *)rte->rt_gateway;
96 		return (ifnet_byindex(sdl->sdl_index));
97 	}
98 
99 	return (ifp);
100 }
101 
102 static void
103 fib6_rte_to_nh_basic(struct rtentry *rte, const struct in6_addr *dst,
104     uint32_t flags, struct nhop6_basic *pnh6)
105 {
106 	struct sockaddr_in6 *gw;
107 
108 	/* Do explicit nexthop zero unless we're copying it */
109 	memset(pnh6, 0, sizeof(*pnh6));
110 
111 	if ((flags & NHR_IFAIF) != 0)
112 		pnh6->nh_ifp = fib6_get_ifaifp(rte);
113 	else
114 		pnh6->nh_ifp = rte->rt_ifp;
115 
116 	pnh6->nh_mtu = min(rte->rt_mtu, IN6_LINKMTU(rte->rt_ifp));
117 	if (rte->rt_flags & RTF_GATEWAY) {
118 		gw = (struct sockaddr_in6 *)rte->rt_gateway;
119 		pnh6->nh_addr = gw->sin6_addr;
120 		in6_clearscope(&pnh6->nh_addr);
121 	} else
122 		pnh6->nh_addr = *dst;
123 	/* Set flags */
124 	pnh6->nh_flags = fib_rte_to_nh_flags(rte->rt_flags);
125 	gw = (struct sockaddr_in6 *)rt_key(rte);
126 	if (IN6_IS_ADDR_UNSPECIFIED(&gw->sin6_addr))
127 		pnh6->nh_flags |= NHF_DEFAULT;
128 }
129 
130 static void
131 fib6_rte_to_nh_extended(struct rtentry *rte, const struct in6_addr *dst,
132     uint32_t flags, struct nhop6_extended *pnh6)
133 {
134 	struct sockaddr_in6 *gw;
135 
136 	/* Do explicit nexthop zero unless we're copying it */
137 	memset(pnh6, 0, sizeof(*pnh6));
138 
139 	if ((flags & NHR_IFAIF) != 0)
140 		pnh6->nh_ifp = fib6_get_ifaifp(rte);
141 	else
142 		pnh6->nh_ifp = rte->rt_ifp;
143 
144 	pnh6->nh_mtu = min(rte->rt_mtu, IN6_LINKMTU(rte->rt_ifp));
145 	if (rte->rt_flags & RTF_GATEWAY) {
146 		gw = (struct sockaddr_in6 *)rte->rt_gateway;
147 		pnh6->nh_addr = gw->sin6_addr;
148 		in6_clearscope(&pnh6->nh_addr);
149 	} else
150 		pnh6->nh_addr = *dst;
151 	/* Set flags */
152 	pnh6->nh_flags = fib_rte_to_nh_flags(rte->rt_flags);
153 	gw = (struct sockaddr_in6 *)rt_key(rte);
154 	if (IN6_IS_ADDR_UNSPECIFIED(&gw->sin6_addr))
155 		pnh6->nh_flags |= NHF_DEFAULT;
156 }
157 
158 /*
159  * Performs IPv6 route table lookup on @dst. Returns 0 on success.
160  * Stores basic nexthop info into provided @pnh6 structure.
161  * Note that
162  * - nh_ifp represents logical transmit interface (rt_ifp) by default
163  * - nh_ifp represents "address" interface if NHR_IFAIF flag is passed
164  * - mtu from logical transmit interface will be returned.
165  * - nh_ifp cannot be safely dereferenced
166  * - nh_ifp represents rt_ifp (e.g. if looking up address on
167  *   interface "ix0" pointer to "ix0" interface will be returned instead
168  *   of "lo0")
169  * - howewer mtu from "transmit" interface will be returned.
170  * - scope will be embedded in nh_addr
171  */
172 int
173 fib6_lookup_nh_basic(uint32_t fibnum, const struct in6_addr *dst, uint32_t scopeid,
174     uint32_t flags, uint32_t flowid, struct nhop6_basic *pnh6)
175 {
176 	RIB_RLOCK_TRACKER;
177 	struct rib_head *rh;
178 	struct radix_node *rn;
179 	struct sockaddr_in6 sin6;
180 	struct rtentry *rte;
181 
182 	KASSERT((fibnum < rt_numfibs), ("fib6_lookup_nh_basic: bad fibnum"));
183 	rh = rt_tables_get_rnh(fibnum, AF_INET6);
184 	if (rh == NULL)
185 		return (ENOENT);
186 
187 	/* Prepare lookup key */
188 	memset(&sin6, 0, sizeof(sin6));
189 	sin6.sin6_addr = *dst;
190 	sin6.sin6_len = sizeof(struct sockaddr_in6);
191 	/* Assume scopeid is valid and embed it directly */
192 	if (IN6_IS_SCOPE_LINKLOCAL(dst))
193 		sin6.sin6_addr.s6_addr16[1] = htons(scopeid & 0xffff);
194 
195 	RIB_RLOCK(rh);
196 	rn = rh->rnh_matchaddr((void *)&sin6, &rh->head);
197 	if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
198 		rte = RNTORT(rn);
199 		/* Ensure route & ifp is UP */
200 		if (RT_LINK_IS_UP(rte->rt_ifp)) {
201 			fib6_rte_to_nh_basic(rte, &sin6.sin6_addr, flags, pnh6);
202 			RIB_RUNLOCK(rh);
203 			return (0);
204 		}
205 	}
206 	RIB_RUNLOCK(rh);
207 
208 	return (ENOENT);
209 }
210 
211 /*
212  * Performs IPv6 route table lookup on @dst. Returns 0 on success.
213  * Stores extended nexthop info into provided @pnh6 structure.
214  * Note that
215  * - nh_ifp cannot be safely dereferenced unless NHR_REF is specified.
216  * - in that case you need to call fib6_free_nh_ext()
217  * - nh_ifp represents logical transmit interface (rt_ifp) by default
218  * - nh_ifp represents "address" interface if NHR_IFAIF flag is passed
219  * - mtu from logical transmit interface will be returned.
220  * - scope will be embedded in nh_addr
221  */
222 int
223 fib6_lookup_nh_ext(uint32_t fibnum, const struct in6_addr *dst,uint32_t scopeid,
224     uint32_t flags, uint32_t flowid, struct nhop6_extended *pnh6)
225 {
226 	RIB_RLOCK_TRACKER;
227 	struct rib_head *rh;
228 	struct radix_node *rn;
229 	struct sockaddr_in6 sin6;
230 	struct rtentry *rte;
231 
232 	KASSERT((fibnum < rt_numfibs), ("fib6_lookup_nh_ext: bad fibnum"));
233 	rh = rt_tables_get_rnh(fibnum, AF_INET6);
234 	if (rh == NULL)
235 		return (ENOENT);
236 
237 	/* Prepare lookup key */
238 	memset(&sin6, 0, sizeof(sin6));
239 	sin6.sin6_len = sizeof(struct sockaddr_in6);
240 	sin6.sin6_addr = *dst;
241 	/* Assume scopeid is valid and embed it directly */
242 	if (IN6_IS_SCOPE_LINKLOCAL(dst))
243 		sin6.sin6_addr.s6_addr16[1] = htons(scopeid & 0xffff);
244 
245 	RIB_RLOCK(rh);
246 	rn = rh->rnh_matchaddr((void *)&sin6, &rh->head);
247 	if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
248 		rte = RNTORT(rn);
249 #ifdef RADIX_MPATH
250 		rte = rt_mpath_select(rte, flowid);
251 		if (rte == NULL) {
252 			RIB_RUNLOCK(rh);
253 			return (ENOENT);
254 		}
255 #endif
256 		/* Ensure route & ifp is UP */
257 		if (RT_LINK_IS_UP(rte->rt_ifp)) {
258 			fib6_rte_to_nh_extended(rte, &sin6.sin6_addr, flags,
259 			    pnh6);
260 			if ((flags & NHR_REF) != 0) {
261 				/* TODO: Do lwref on egress ifp's */
262 			}
263 			RIB_RUNLOCK(rh);
264 
265 			return (0);
266 		}
267 	}
268 	RIB_RUNLOCK(rh);
269 
270 	return (ENOENT);
271 }
272 
273 void
274 fib6_free_nh_ext(uint32_t fibnum, struct nhop6_extended *pnh6)
275 {
276 
277 }
278 
279 #endif
280 
281