xref: /freebsd/sys/net/if_llatbl.c (revision aa64588d28258aef88cc33b8043112e8856948d0) 
1 /*
2  * Copyright (c) 2004 Luigi Rizzo, Alessandro Cerri. All rights reserved.
3  * Copyright (c) 2004-2008 Qing Li. All rights reserved.
4  * Copyright (c) 2008 Kip Macy. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include "opt_ddb.h"
31 #include "opt_inet.h"
32 #include "opt_inet6.h"
33 
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/malloc.h>
37 #include <sys/mbuf.h>
38 #include <sys/syslog.h>
39 #include <sys/sysctl.h>
40 #include <sys/socket.h>
41 #include <sys/kernel.h>
42 #include <sys/lock.h>
43 #include <sys/mutex.h>
44 #include <sys/rwlock.h>
45 
46 #ifdef DDB
47 #include <ddb/ddb.h>
48 #endif
49 
50 #include <vm/uma.h>
51 
52 #include <netinet/in.h>
53 #include <net/if_llatbl.h>
54 #include <net/if.h>
55 #include <net/if_dl.h>
56 #include <net/if_var.h>
57 #include <net/route.h>
58 #include <net/vnet.h>
59 #include <netinet/if_ether.h>
60 #include <netinet6/in6_var.h>
61 #include <netinet6/nd6.h>
62 
63 MALLOC_DEFINE(M_LLTABLE, "lltable", "link level address tables");
64 
65 static VNET_DEFINE(SLIST_HEAD(, lltable), lltables);
66 #define	V_lltables	VNET(lltables)
67 
68 extern void arprequest(struct ifnet *, struct in_addr *, struct in_addr *,
69 	u_char *);
70 
71 static void vnet_lltable_init(void);
72 
73 struct rwlock lltable_rwlock;
74 RW_SYSINIT(lltable_rwlock, &lltable_rwlock, "lltable_rwlock");
75 
76 /*
77  * Dump arp state for a specific address family.
78  */
79 int
80 lltable_sysctl_dumparp(int af, struct sysctl_req *wr)
81 {
82 	struct lltable *llt;
83 	int error = 0;
84 
85 	LLTABLE_RLOCK();
86 	SLIST_FOREACH(llt, &V_lltables, llt_link) {
87 		if (llt->llt_af == af) {
88 			error = llt->llt_dump(llt, wr);
89 			if (error != 0)
90 				goto done;
91 		}
92 	}
93 done:
94 	LLTABLE_RUNLOCK();
95 	return (error);
96 }
97 
98 /*
99  * Deletes an address from the address table.
100  * This function is called by the timer functions
101  * such as arptimer() and nd6_llinfo_timer(), and
102  * the caller does the locking.
103  */
104 void
105 llentry_free(struct llentry *lle)
106 {
107 
108 	LLE_WLOCK_ASSERT(lle);
109 	LIST_REMOVE(lle, lle_next);
110 
111 	if (lle->la_hold != NULL)
112 		m_freem(lle->la_hold);
113 
114 	LLE_FREE_LOCKED(lle);
115 }
116 
117 /*
118  * Update an llentry for address dst (equivalent to rtalloc for new-arp)
119  * Caller must pass in a valid struct llentry * (or NULL)
120  *
121  * if found the llentry * is returned referenced and unlocked
122  */
123 int
124 llentry_update(struct llentry **llep, struct lltable *lt,
125     struct sockaddr_storage *dst, struct ifnet *ifp)
126 {
127 	struct llentry *la;
128 
129 	IF_AFDATA_RLOCK(ifp);
130 	la = lla_lookup(lt, LLE_EXCLUSIVE,
131 	    (struct sockaddr *)dst);
132 	IF_AFDATA_RUNLOCK(ifp);
133 	if ((la == NULL) &&
134 	    (ifp->if_flags & (IFF_NOARP | IFF_STATICARP)) == 0) {
135 		IF_AFDATA_WLOCK(ifp);
136 		la = lla_lookup(lt,
137 		    (LLE_CREATE | LLE_EXCLUSIVE),
138 		    (struct sockaddr *)dst);
139 		IF_AFDATA_WUNLOCK(ifp);
140 	}
141 	if (la != NULL && (*llep != la)) {
142 		if (*llep != NULL)
143 			LLE_FREE(*llep);
144 		LLE_ADDREF(la);
145 		LLE_WUNLOCK(la);
146 		*llep = la;
147 	} else if (la != NULL)
148 		LLE_WUNLOCK(la);
149 
150 	if (la == NULL)
151 		return (ENOENT);
152 
153 	return (0);
154 }
155 
156 /*
157  * Free all entries from given table and free itself.
158  */
159 void
160 lltable_free(struct lltable *llt)
161 {
162 	struct llentry *lle, *next;
163 	int i;
164 
165 	KASSERT(llt != NULL, ("%s: llt is NULL", __func__));
166 
167 	LLTABLE_WLOCK();
168 	SLIST_REMOVE(&V_lltables, llt, lltable, llt_link);
169 	LLTABLE_WUNLOCK();
170 
171 	for (i=0; i < LLTBL_HASHTBL_SIZE; i++) {
172 		LIST_FOREACH_SAFE(lle, &llt->lle_head[i], lle_next, next) {
173 			int canceled;
174 
175 			canceled = callout_drain(&lle->la_timer);
176 			LLE_WLOCK(lle);
177 			if (canceled)
178 				LLE_REMREF(lle);
179 			llentry_free(lle);
180 		}
181 	}
182 
183 	free(llt, M_LLTABLE);
184 }
185 
186 void
187 lltable_drain(int af)
188 {
189 	struct lltable	*llt;
190 	struct llentry	*lle;
191 	register int i;
192 
193 	LLTABLE_RLOCK();
194 	SLIST_FOREACH(llt, &V_lltables, llt_link) {
195 		if (llt->llt_af != af)
196 			continue;
197 
198 		for (i=0; i < LLTBL_HASHTBL_SIZE; i++) {
199 			LIST_FOREACH(lle, &llt->lle_head[i], lle_next) {
200 				if (lle->la_hold) {
201 					m_freem(lle->la_hold);
202 					lle->la_hold = NULL;
203 				}
204 			}
205 		}
206 	}
207 	LLTABLE_RUNLOCK();
208 }
209 
210 void
211 lltable_prefix_free(int af, struct sockaddr *prefix, struct sockaddr *mask)
212 {
213 	struct lltable *llt;
214 
215 	LLTABLE_RLOCK();
216 	SLIST_FOREACH(llt, &V_lltables, llt_link) {
217 		if (llt->llt_af != af)
218 			continue;
219 
220 		llt->llt_prefix_free(llt, prefix, mask);
221 	}
222 	LLTABLE_RUNLOCK();
223 }
224 
225 
226 
227 /*
228  * Create a new lltable.
229  */
230 struct lltable *
231 lltable_init(struct ifnet *ifp, int af)
232 {
233 	struct lltable *llt;
234 	register int i;
235 
236 	llt = malloc(sizeof(struct lltable), M_LLTABLE, M_WAITOK);
237 	if (llt == NULL)
238 		return (NULL);
239 
240 	llt->llt_af = af;
241 	llt->llt_ifp = ifp;
242 	for (i = 0; i < LLTBL_HASHTBL_SIZE; i++)
243 		LIST_INIT(&llt->lle_head[i]);
244 
245 	LLTABLE_WLOCK();
246 	SLIST_INSERT_HEAD(&V_lltables, llt, llt_link);
247 	LLTABLE_WUNLOCK();
248 
249 	return (llt);
250 }
251 
252 /*
253  * Called in route_output when adding/deleting a route to an interface.
254  */
255 int
256 lla_rt_output(struct rt_msghdr *rtm, struct rt_addrinfo *info)
257 {
258 	struct sockaddr_dl *dl =
259 	    (struct sockaddr_dl *)info->rti_info[RTAX_GATEWAY];
260 	struct sockaddr *dst = (struct sockaddr *)info->rti_info[RTAX_DST];
261 	struct ifnet *ifp;
262 	struct lltable *llt;
263 	struct llentry *lle;
264 	u_int laflags = 0, flags = 0;
265 	int error = 0;
266 
267 	if (dl == NULL || dl->sdl_family != AF_LINK) {
268 		log(LOG_INFO, "%s: invalid dl\n", __func__);
269 		return EINVAL;
270 	}
271 	ifp = ifnet_byindex(dl->sdl_index);
272 	if (ifp == NULL) {
273 		log(LOG_INFO, "%s: invalid ifp (sdl_index %d)\n",
274 		    __func__, dl->sdl_index);
275 		return EINVAL;
276 	}
277 
278 	switch (rtm->rtm_type) {
279 	case RTM_ADD:
280 		if (rtm->rtm_flags & RTF_ANNOUNCE) {
281 			flags |= LLE_PUB;
282 #ifdef INET
283 			if (dst->sa_family == AF_INET &&
284 			    ((struct sockaddr_inarp *)dst)->sin_other != 0) {
285 				struct rtentry *rt;
286 				((struct sockaddr_inarp *)dst)->sin_other = 0;
287 				rt = rtalloc1(dst, 0, 0);
288 				if (rt == NULL || !(rt->rt_flags & RTF_HOST)) {
289 					log(LOG_INFO, "%s: RTM_ADD publish "
290 					    "(proxy only) is invalid\n",
291 					    __func__);
292 					if (rt)
293 						RTFREE_LOCKED(rt);
294 					return EINVAL;
295 				}
296 				RTFREE_LOCKED(rt);
297 
298 				flags |= LLE_PROXY;
299 			}
300 #endif
301 		}
302 		flags |= LLE_CREATE;
303 		break;
304 
305 	case RTM_DELETE:
306 		flags |= LLE_DELETE;
307 		break;
308 
309 	case RTM_CHANGE:
310 		break;
311 
312 	default:
313 		return EINVAL; /* XXX not implemented yet */
314 	}
315 
316 	/* XXX linked list may be too expensive */
317 	LLTABLE_RLOCK();
318 	SLIST_FOREACH(llt, &V_lltables, llt_link) {
319 		if (llt->llt_af == dst->sa_family &&
320 		    llt->llt_ifp == ifp)
321 			break;
322 	}
323 	LLTABLE_RUNLOCK();
324 	KASSERT(llt != NULL, ("Yep, ugly hacks are bad\n"));
325 
326 	if (flags && LLE_CREATE)
327 		flags |= LLE_EXCLUSIVE;
328 
329 	IF_AFDATA_LOCK(ifp);
330 	lle = lla_lookup(llt, flags, dst);
331 	IF_AFDATA_UNLOCK(ifp);
332 	if (LLE_IS_VALID(lle)) {
333 		if (flags & LLE_CREATE) {
334 			/*
335 			 * If we delay the delete, then a subsequent
336 			 * "arp add" should look up this entry, reset the
337 			 * LLE_DELETED flag, and reset the expiration timer
338 			 */
339 			bcopy(LLADDR(dl), &lle->ll_addr, ifp->if_addrlen);
340 			lle->la_flags |= LLE_VALID;
341 			lle->la_flags &= ~LLE_DELETED;
342 #ifdef INET6
343 			/*
344 			 * ND6
345 			 */
346 			if (dst->sa_family == AF_INET6)
347 				lle->ln_state = ND6_LLINFO_REACHABLE;
348 #endif
349 			/*
350 			 * NB: arp and ndp always set (RTF_STATIC | RTF_HOST)
351 			 */
352 
353 			if (rtm->rtm_rmx.rmx_expire == 0) {
354 				lle->la_flags |= LLE_STATIC;
355 				lle->la_expire = 0;
356 			} else
357 				lle->la_expire = rtm->rtm_rmx.rmx_expire;
358 			laflags = lle->la_flags;
359 			LLE_WUNLOCK(lle);
360 #ifdef INET
361 			/*  gratuitous ARP */
362 			if ((laflags & LLE_PUB) && dst->sa_family == AF_INET) {
363 				arprequest(ifp,
364 				    &((struct sockaddr_in *)dst)->sin_addr,
365 				    &((struct sockaddr_in *)dst)->sin_addr,
366 				    ((laflags & LLE_PROXY) ?
367 					(u_char *)IF_LLADDR(ifp) :
368 					(u_char *)LLADDR(dl)));
369 			}
370 #endif
371 		} else {
372 			if (flags & LLE_EXCLUSIVE)
373 				LLE_WUNLOCK(lle);
374 			else
375 				LLE_RUNLOCK(lle);
376 		}
377 	} else if ((lle == NULL) && (flags & LLE_DELETE))
378 		error = EINVAL;
379 
380 
381 	return (error);
382 }
383 
384 static void
385 vnet_lltable_init()
386 {
387 
388 	SLIST_INIT(&V_lltables);
389 }
390 VNET_SYSINIT(vnet_lltable_init, SI_SUB_PSEUDO, SI_ORDER_FIRST,
391     vnet_lltable_init, NULL);
392 
393 #ifdef DDB
394 struct llentry_sa {
395 	struct llentry		base;
396 	struct sockaddr		l3_addr;
397 };
398 
399 static void
400 llatbl_lle_show(struct llentry_sa *la)
401 {
402 	struct llentry *lle;
403 	uint8_t octet[6];
404 
405 	lle = &la->base;
406 	db_printf("lle=%p\n", lle);
407 	db_printf(" lle_next=%p\n", lle->lle_next.le_next);
408 	db_printf(" lle_lock=%p\n", &lle->lle_lock);
409 	db_printf(" lle_tbl=%p\n", lle->lle_tbl);
410 	db_printf(" lle_head=%p\n", lle->lle_head);
411 	db_printf(" la_hold=%p\n", lle->la_hold);
412 	db_printf(" la_expire=%ju\n", (uintmax_t)lle->la_expire);
413 	db_printf(" la_flags=0x%04x\n", lle->la_flags);
414 	db_printf(" la_asked=%u\n", lle->la_asked);
415 	db_printf(" la_preempt=%u\n", lle->la_preempt);
416 	db_printf(" ln_byhint=%u\n", lle->ln_byhint);
417 	db_printf(" ln_state=%d\n", lle->ln_state);
418 	db_printf(" ln_router=%u\n", lle->ln_router);
419 	db_printf(" ln_ntick=%ju\n", (uintmax_t)lle->ln_ntick);
420 	db_printf(" lle_refcnt=%d\n", lle->lle_refcnt);
421 	bcopy(&lle->ll_addr.mac16, octet, sizeof(octet));
422 	db_printf(" ll_addr=%02x:%02x:%02x:%02x:%02x:%02x\n",
423 	    octet[0], octet[1], octet[2], octet[3], octet[4], octet[5]);
424 	db_printf(" la_timer=%p\n", &lle->la_timer);
425 
426 	switch (la->l3_addr.sa_family) {
427 #ifdef INET
428 	case AF_INET:
429 	{
430 		struct sockaddr_in *sin;
431 		char l3s[INET_ADDRSTRLEN];
432 
433 		sin = (struct sockaddr_in *)&la->l3_addr;
434 		inet_ntoa_r(sin->sin_addr, l3s);
435 		db_printf(" l3_addr=%s\n", l3s);
436 		break;
437 	}
438 #endif
439 #ifdef INET6
440 	case AF_INET6:
441 	{
442 		struct sockaddr_in6 *sin6;
443 		char l3s[INET6_ADDRSTRLEN];
444 
445 		sin6 = (struct sockaddr_in6 *)&la->l3_addr;
446 		ip6_sprintf(l3s, &sin6->sin6_addr);
447 		db_printf(" l3_addr=%s\n", l3s);
448 		break;
449 	}
450 #endif
451 	default:
452 		db_printf(" l3_addr=N/A (af=%d)\n", la->l3_addr.sa_family);
453 		break;
454 	}
455 }
456 
457 DB_SHOW_COMMAND(llentry, db_show_llentry)
458 {
459 
460 	if (!have_addr) {
461 		db_printf("usage: show llentry <struct llentry *>\n");
462 		return;
463 	}
464 
465 	llatbl_lle_show((struct llentry_sa *)addr);
466 }
467 
468 static void
469 llatbl_llt_show(struct lltable *llt)
470 {
471 	int i;
472 	struct llentry *lle;
473 
474 	db_printf("llt=%p llt_af=%d llt_ifp=%p\n",
475 	    llt, llt->llt_af, llt->llt_ifp);
476 
477 	for (i = 0; i < LLTBL_HASHTBL_SIZE; i++) {
478 		LIST_FOREACH(lle, &llt->lle_head[i], lle_next) {
479 
480 			llatbl_lle_show((struct llentry_sa *)lle);
481 			if (db_pager_quit)
482 				return;
483 		}
484 	}
485 }
486 
487 DB_SHOW_COMMAND(lltable, db_show_lltable)
488 {
489 
490 	if (!have_addr) {
491 		db_printf("usage: show lltable <struct lltable *>\n");
492 		return;
493 	}
494 
495 	llatbl_llt_show((struct lltable *)addr);
496 }
497 
498 DB_SHOW_ALL_COMMAND(lltables, db_show_all_lltables)
499 {
500 	VNET_ITERATOR_DECL(vnet_iter);
501 	struct lltable *llt;
502 
503 	VNET_FOREACH(vnet_iter) {
504 		CURVNET_SET_QUIET(vnet_iter);
505 #ifdef VIMAGE
506 		db_printf("vnet=%p\n", curvnet);
507 #endif
508 		SLIST_FOREACH(llt, &V_lltables, llt_link) {
509 			db_printf("llt=%p llt_af=%d llt_ifp=%p(%s)\n",
510 			    llt, llt->llt_af, llt->llt_ifp,
511 			    (llt->llt_ifp != NULL) ?
512 				llt->llt_ifp->if_xname : "?");
513 			if (have_addr && addr != 0) /* verbose */
514 				llatbl_llt_show(llt);
515 			if (db_pager_quit) {
516 				CURVNET_RESTORE();
517 				return;
518 			}
519 		}
520 		CURVNET_RESTORE();
521 	}
522 }
523 #endif
524