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