xref: /freebsd/sys/netinet/in_fib.c (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
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_route.h"
35 #include "opt_mpath.h"
36 
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/lock.h>
40 #include <sys/rmlock.h>
41 #include <sys/malloc.h>
42 #include <sys/mbuf.h>
43 #include <sys/socket.h>
44 #include <sys/sysctl.h>
45 #include <sys/kernel.h>
46 
47 #include <net/if.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/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/in_fib.h>
61 
62 #ifdef INET
63 static void fib4_rte_to_nh_basic(struct rtentry *rte, struct in_addr dst,
64     uint32_t flags, struct nhop4_basic *pnh4);
65 static void fib4_rte_to_nh_extended(struct rtentry *rte, struct in_addr dst,
66     uint32_t flags, struct nhop4_extended *pnh4);
67 
68 #define RNTORT(p)	((struct rtentry *)(p))
69 
70 static void
71 fib4_rte_to_nh_basic(struct rtentry *rte, struct in_addr dst,
72     uint32_t flags, struct nhop4_basic *pnh4)
73 {
74 	struct sockaddr_in *gw;
75 
76 	if ((flags & NHR_IFAIF) != 0)
77 		pnh4->nh_ifp = rte->rt_ifa->ifa_ifp;
78 	else
79 		pnh4->nh_ifp = rte->rt_ifp;
80 	pnh4->nh_mtu = min(rte->rt_mtu, rte->rt_ifp->if_mtu);
81 	if (rte->rt_flags & RTF_GATEWAY) {
82 		gw = (struct sockaddr_in *)rte->rt_gateway;
83 		pnh4->nh_addr = gw->sin_addr;
84 	} else
85 		pnh4->nh_addr = dst;
86 	/* Set flags */
87 	pnh4->nh_flags = fib_rte_to_nh_flags(rte->rt_flags);
88 	gw = (struct sockaddr_in *)rt_key(rte);
89 	if (gw->sin_addr.s_addr == 0)
90 		pnh4->nh_flags |= NHF_DEFAULT;
91 	/* TODO: Handle RTF_BROADCAST here */
92 }
93 
94 static void
95 fib4_rte_to_nh_extended(struct rtentry *rte, struct in_addr dst,
96     uint32_t flags, struct nhop4_extended *pnh4)
97 {
98 	struct sockaddr_in *gw;
99 
100 	if ((flags & NHR_IFAIF) != 0)
101 		pnh4->nh_ifp = rte->rt_ifa->ifa_ifp;
102 	else
103 		pnh4->nh_ifp = rte->rt_ifp;
104 	pnh4->nh_mtu = min(rte->rt_mtu, rte->rt_ifp->if_mtu);
105 	if (rte->rt_flags & RTF_GATEWAY) {
106 		gw = (struct sockaddr_in *)rte->rt_gateway;
107 		pnh4->nh_addr = gw->sin_addr;
108 	} else
109 		pnh4->nh_addr = dst;
110 	/* Set flags */
111 	pnh4->nh_flags = fib_rte_to_nh_flags(rte->rt_flags);
112 	gw = (struct sockaddr_in *)rt_key(rte);
113 	if (gw->sin_addr.s_addr == 0)
114 		pnh4->nh_flags |= NHF_DEFAULT;
115 	pnh4->nh_ia = ifatoia(rte->rt_ifa);
116 	pnh4->nh_src = IA_SIN(pnh4->nh_ia)->sin_addr;
117 }
118 
119 /*
120  * Performs IPv4 route table lookup on @dst. Returns 0 on success.
121  * Stores nexthop info provided @pnh4 structure.
122  * Note that
123  * - nh_ifp cannot be safely dereferenced
124  * - nh_ifp represents logical transmit interface (rt_ifp) (e.g. if
125  *   looking up address on interface "ix0" pointer to "lo0" interface
126  *   will be returned instead of "ix0")
127  * - nh_ifp represents "address" interface if NHR_IFAIF flag is passed
128  * - howewer mtu from "transmit" interface will be returned.
129  */
130 int
131 fib4_lookup_nh_basic(uint32_t fibnum, struct in_addr dst, uint32_t flags,
132     uint32_t flowid, struct nhop4_basic *pnh4)
133 {
134 	RIB_RLOCK_TRACKER;
135 	struct rib_head *rh;
136 	struct radix_node *rn;
137 	struct sockaddr_in sin;
138 	struct rtentry *rte;
139 
140 	KASSERT((fibnum < rt_numfibs), ("fib4_lookup_nh_basic: bad fibnum"));
141 	rh = rt_tables_get_rnh(fibnum, AF_INET);
142 	if (rh == NULL)
143 		return (ENOENT);
144 
145 	/* Prepare lookup key */
146 	memset(&sin, 0, sizeof(sin));
147 	sin.sin_len = sizeof(struct sockaddr_in);
148 	sin.sin_addr = dst;
149 
150 	RIB_RLOCK(rh);
151 	rn = rh->rnh_matchaddr((void *)&sin, &rh->head);
152 	if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
153 		rte = RNTORT(rn);
154 		/* Ensure route & ifp is UP */
155 		if (RT_LINK_IS_UP(rte->rt_ifp)) {
156 			fib4_rte_to_nh_basic(rte, dst, flags, pnh4);
157 			RIB_RUNLOCK(rh);
158 
159 			return (0);
160 		}
161 	}
162 	RIB_RUNLOCK(rh);
163 
164 	return (ENOENT);
165 }
166 
167 /*
168  * Performs IPv4 route table lookup on @dst. Returns 0 on success.
169  * Stores extende nexthop info provided @pnh4 structure.
170  * Note that
171  * - nh_ifp cannot be safely dereferenced unless NHR_REF is specified.
172  * - in that case you need to call fib4_free_nh_ext()
173  * - nh_ifp represents logical transmit interface (rt_ifp) (e.g. if
174  *   looking up address of interface "ix0" pointer to "lo0" interface
175  *   will be returned instead of "ix0")
176  * - nh_ifp represents "address" interface if NHR_IFAIF flag is passed
177  * - howewer mtu from "transmit" interface will be returned.
178  */
179 int
180 fib4_lookup_nh_ext(uint32_t fibnum, struct in_addr dst, uint32_t flags,
181     uint32_t flowid, struct nhop4_extended *pnh4)
182 {
183 	RIB_RLOCK_TRACKER;
184 	struct rib_head *rh;
185 	struct radix_node *rn;
186 	struct sockaddr_in sin;
187 	struct rtentry *rte;
188 
189 	KASSERT((fibnum < rt_numfibs), ("fib4_lookup_nh_ext: bad fibnum"));
190 	rh = rt_tables_get_rnh(fibnum, AF_INET);
191 	if (rh == NULL)
192 		return (ENOENT);
193 
194 	/* Prepare lookup key */
195 	memset(&sin, 0, sizeof(sin));
196 	sin.sin_len = sizeof(struct sockaddr_in);
197 	sin.sin_addr = dst;
198 
199 	RIB_RLOCK(rh);
200 	rn = rh->rnh_matchaddr((void *)&sin, &rh->head);
201 	if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
202 		rte = RNTORT(rn);
203 #ifdef RADIX_MPATH
204 		rte = rt_mpath_select(rte, flowid);
205 		if (rte == NULL) {
206 			RIB_RUNLOCK(rh);
207 			return (ENOENT);
208 		}
209 #endif
210 		/* Ensure route & ifp is UP */
211 		if (RT_LINK_IS_UP(rte->rt_ifp)) {
212 			fib4_rte_to_nh_extended(rte, dst, flags, pnh4);
213 			if ((flags & NHR_REF) != 0) {
214 				/* TODO: lwref on egress ifp's ? */
215 			}
216 			RIB_RUNLOCK(rh);
217 
218 			return (0);
219 		}
220 	}
221 	RIB_RUNLOCK(rh);
222 
223 	return (ENOENT);
224 }
225 
226 void
227 fib4_free_nh_ext(uint32_t fibnum, struct nhop4_extended *pnh4)
228 {
229 
230 }
231 
232 #endif
233