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.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
32 #include "opt_inet6.h"
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/malloc.h>
38 #include <sys/syslog.h>
39 #include <sys/sysctl.h>
40 #include <sys/socket.h>
41 #include <sys/kernel.h>
43 #include <sys/mutex.h>
44 #include <sys/rwlock.h>
52 #include <netinet/in.h>
53 #include <net/if_llatbl.h>
55 #include <net/if_dl.h>
56 #include <net/if_var.h>
57 #include <net/route.h>
59 #include <netinet/if_ether.h>
60 #include <netinet6/in6_var.h>
61 #include <netinet6/nd6.h>
63 MALLOC_DEFINE(M_LLTABLE, "lltable", "link level address tables");
65 static VNET_DEFINE(SLIST_HEAD(, lltable), lltables);
66 #define V_lltables VNET(lltables)
68 static void vnet_lltable_init(void);
70 struct rwlock lltable_rwlock;
71 RW_SYSINIT(lltable_rwlock, &lltable_rwlock, "lltable_rwlock");
73 static void lltable_unlink(struct lltable *llt);
74 static void llentries_unlink(struct lltable *llt, struct llentries *head);
76 static void htable_unlink_entry(struct llentry *lle);
77 static void htable_link_entry(struct lltable *llt, struct llentry *lle);
78 static int htable_foreach_lle(struct lltable *llt, llt_foreach_cb_t *f,
82 * Dump lle state for a specific address family.
85 lltable_dump_af(struct lltable *llt, struct sysctl_req *wr)
89 LLTABLE_LOCK_ASSERT();
91 if (llt->llt_ifp->if_flags & IFF_LOOPBACK)
95 IF_AFDATA_RLOCK(llt->llt_ifp);
96 error = lltable_foreach_lle(llt,
97 (llt_foreach_cb_t *)llt->llt_dump_entry, wr);
98 IF_AFDATA_RUNLOCK(llt->llt_ifp);
104 * Dump arp state for a specific address family.
107 lltable_sysctl_dumparp(int af, struct sysctl_req *wr)
113 SLIST_FOREACH(llt, &V_lltables, llt_link) {
114 if (llt->llt_af == af) {
115 error = lltable_dump_af(llt, wr);
126 * Common function helpers for chained hash table.
130 * Runs specified callback for each entry in @llt.
131 * Caller does the locking.
135 htable_foreach_lle(struct lltable *llt, llt_foreach_cb_t *f, void *farg)
137 struct llentry *lle, *next;
142 for (i = 0; i < llt->llt_hsize; i++) {
143 LIST_FOREACH_SAFE(lle, &llt->lle_head[i], lle_next, next) {
144 error = f(llt, lle, farg);
154 htable_link_entry(struct lltable *llt, struct llentry *lle)
156 struct llentries *lleh;
159 if ((lle->la_flags & LLE_LINKED) != 0)
162 IF_AFDATA_WLOCK_ASSERT(llt->llt_ifp);
164 hashidx = llt->llt_hash(lle, llt->llt_hsize);
165 lleh = &llt->lle_head[hashidx];
168 lle->lle_head = lleh;
169 lle->la_flags |= LLE_LINKED;
170 LIST_INSERT_HEAD(lleh, lle, lle_next);
174 htable_unlink_entry(struct llentry *lle)
177 if ((lle->la_flags & LLE_LINKED) != 0) {
178 IF_AFDATA_WLOCK_ASSERT(lle->lle_tbl->llt_ifp);
179 LIST_REMOVE(lle, lle_next);
180 lle->la_flags &= ~(LLE_VALID | LLE_LINKED);
183 lle->lle_head = NULL;
188 struct prefix_match_data {
189 const struct sockaddr *prefix;
190 const struct sockaddr *mask;
191 struct llentries dchain;
196 htable_prefix_free_cb(struct lltable *llt, struct llentry *lle, void *farg)
198 struct prefix_match_data *pmd;
200 pmd = (struct prefix_match_data *)farg;
202 if (llt->llt_match_prefix(pmd->prefix, pmd->mask, pmd->flags, lle)) {
204 LIST_INSERT_HEAD(&pmd->dchain, lle, lle_chain);
211 htable_prefix_free(struct lltable *llt, const struct sockaddr *prefix,
212 const struct sockaddr *mask, u_int flags)
214 struct llentry *lle, *next;
215 struct prefix_match_data pmd;
217 bzero(&pmd, sizeof(pmd));
221 LIST_INIT(&pmd.dchain);
223 IF_AFDATA_WLOCK(llt->llt_ifp);
224 /* Push matching lles to chain */
225 lltable_foreach_lle(llt, htable_prefix_free_cb, &pmd);
227 llentries_unlink(llt, &pmd.dchain);
228 IF_AFDATA_WUNLOCK(llt->llt_ifp);
230 LIST_FOREACH_SAFE(lle, &pmd.dchain, lle_chain, next)
231 llt->llt_free_entry(llt, lle);
235 htable_free_tbl(struct lltable *llt)
238 free(llt->lle_head, M_LLTABLE);
239 free(llt, M_LLTABLE);
243 llentries_unlink(struct lltable *llt, struct llentries *head)
245 struct llentry *lle, *next;
247 LIST_FOREACH_SAFE(lle, head, lle_chain, next)
248 llt->llt_unlink_entry(lle);
252 * Helper function used to drop all mbufs in hold queue.
254 * Returns the number of held packets, if any, that were dropped.
257 lltable_drop_entry_queue(struct llentry *lle)
262 LLE_WLOCK_ASSERT(lle);
265 while ((lle->la_numheld > 0) && (lle->la_hold != NULL)) {
266 next = lle->la_hold->m_nextpkt;
267 m_freem(lle->la_hold);
273 KASSERT(lle->la_numheld == 0,
274 ("%s: la_numheld %d > 0, pkts_droped %zd", __func__,
275 lle->la_numheld, pkts_dropped));
277 return (pkts_dropped);
281 * Deletes an address from the address table.
282 * This function is called by the timer functions
283 * such as arptimer() and nd6_llinfo_timer(), and
284 * the caller does the locking.
286 * Returns the number of held packets, if any, that were dropped.
289 llentry_free(struct llentry *lle)
294 LLE_WLOCK_ASSERT(lle);
296 if ((lle->la_flags & LLE_LINKED) != 0) {
299 IF_AFDATA_WLOCK_ASSERT(llt->llt_ifp);
300 llt->llt_unlink_entry(lle);
303 pkts_dropped = lltable_drop_entry_queue(lle);
305 LLE_FREE_LOCKED(lle);
307 return (pkts_dropped);
311 * (al)locate an llentry for address dst (equivalent to rtalloc for new-arp).
313 * If found the llentry * is returned referenced and unlocked.
316 llentry_alloc(struct ifnet *ifp, struct lltable *lt,
317 struct sockaddr_storage *dst)
321 IF_AFDATA_RLOCK(ifp);
322 la = lla_lookup(lt, LLE_EXCLUSIVE, (struct sockaddr *)dst);
323 IF_AFDATA_RUNLOCK(ifp);
325 (ifp->if_flags & (IFF_NOARP | IFF_STATICARP)) == 0) {
326 IF_AFDATA_WLOCK(ifp);
327 la = lla_create(lt, 0, (struct sockaddr *)dst);
328 IF_AFDATA_WUNLOCK(ifp);
340 * Free all entries from given table and free itself.
344 lltable_free_cb(struct lltable *llt, struct llentry *lle, void *farg)
346 struct llentries *dchain;
348 dchain = (struct llentries *)farg;
351 LIST_INSERT_HEAD(dchain, lle, lle_chain);
357 * Free all entries from given table and free itself.
360 lltable_free(struct lltable *llt)
362 struct llentry *lle, *next;
363 struct llentries dchain;
365 KASSERT(llt != NULL, ("%s: llt is NULL", __func__));
370 IF_AFDATA_WLOCK(llt->llt_ifp);
371 /* Push all lles to @dchain */
372 lltable_foreach_lle(llt, lltable_free_cb, &dchain);
373 llentries_unlink(llt, &dchain);
374 IF_AFDATA_WUNLOCK(llt->llt_ifp);
376 LIST_FOREACH_SAFE(lle, &dchain, lle_chain, next) {
377 if (callout_stop(&lle->lle_timer))
382 llt->llt_free_tbl(llt);
387 lltable_drain(int af)
394 SLIST_FOREACH(llt, &V_lltables, llt_link) {
395 if (llt->llt_af != af)
398 for (i=0; i < llt->llt_hsize; i++) {
399 LIST_FOREACH(lle, &llt->lle_head[i], lle_next) {
402 m_freem(lle->la_hold);
414 lltable_prefix_free(int af, struct sockaddr *prefix, struct sockaddr *mask,
420 SLIST_FOREACH(llt, &V_lltables, llt_link) {
421 if (llt->llt_af != af)
424 llt->llt_prefix_free(llt, prefix, mask, flags);
430 lltable_allocate_htbl(uint32_t hsize)
435 llt = malloc(sizeof(struct lltable), M_LLTABLE, M_WAITOK | M_ZERO);
436 llt->llt_hsize = hsize;
437 llt->lle_head = malloc(sizeof(struct llentries) * hsize,
438 M_LLTABLE, M_WAITOK | M_ZERO);
440 for (i = 0; i < llt->llt_hsize; i++)
441 LIST_INIT(&llt->lle_head[i]);
443 /* Set some default callbacks */
444 llt->llt_link_entry = htable_link_entry;
445 llt->llt_unlink_entry = htable_unlink_entry;
446 llt->llt_prefix_free = htable_prefix_free;
447 llt->llt_foreach_entry = htable_foreach_lle;
448 llt->llt_free_tbl = htable_free_tbl;
454 * Links lltable to global llt list.
457 lltable_link(struct lltable *llt)
461 SLIST_INSERT_HEAD(&V_lltables, llt, llt_link);
466 lltable_unlink(struct lltable *llt)
470 SLIST_REMOVE(&V_lltables, llt, lltable, llt_link);
476 * External methods used by lltable consumers
480 lltable_foreach_lle(struct lltable *llt, llt_foreach_cb_t *f, void *farg)
483 return (llt->llt_foreach_entry(llt, f, farg));
487 lltable_link_entry(struct lltable *llt, struct llentry *lle)
490 llt->llt_link_entry(llt, lle);
494 lltable_unlink_entry(struct lltable *llt, struct llentry *lle)
497 llt->llt_unlink_entry(lle);
501 lltable_fill_sa_entry(const struct llentry *lle, struct sockaddr *sa)
506 llt->llt_fill_sa_entry(lle, sa);
510 lltable_get_ifp(const struct lltable *llt)
513 return (llt->llt_ifp);
517 lltable_get_af(const struct lltable *llt)
520 return (llt->llt_af);
524 * Called in route_output when rtm_flags contains RTF_LLDATA.
527 lla_rt_output(struct rt_msghdr *rtm, struct rt_addrinfo *info)
529 struct sockaddr_dl *dl =
530 (struct sockaddr_dl *)info->rti_info[RTAX_GATEWAY];
531 struct sockaddr *dst = (struct sockaddr *)info->rti_info[RTAX_DST];
538 KASSERT(dl != NULL && dl->sdl_family == AF_LINK,
539 ("%s: invalid dl\n", __func__));
541 ifp = ifnet_byindex(dl->sdl_index);
543 log(LOG_INFO, "%s: invalid ifp (sdl_index %d)\n",
544 __func__, dl->sdl_index);
548 /* XXX linked list may be too expensive */
550 SLIST_FOREACH(llt, &V_lltables, llt_link) {
551 if (llt->llt_af == dst->sa_family &&
556 KASSERT(llt != NULL, ("Yep, ugly hacks are bad\n"));
560 switch (rtm->rtm_type) {
563 IF_AFDATA_WLOCK(ifp);
564 lle = lla_create(llt, 0, dst);
566 IF_AFDATA_WUNLOCK(ifp);
571 bcopy(LLADDR(dl), &lle->ll_addr, ifp->if_addrlen);
572 if ((rtm->rtm_flags & RTF_ANNOUNCE))
573 lle->la_flags |= LLE_PUB;
574 lle->la_flags |= LLE_VALID;
579 if (dst->sa_family == AF_INET6)
580 lle->ln_state = ND6_LLINFO_REACHABLE;
583 * NB: arp and ndp always set (RTF_STATIC | RTF_HOST)
586 if (rtm->rtm_rmx.rmx_expire == 0) {
587 lle->la_flags |= LLE_STATIC;
590 lle->la_expire = rtm->rtm_rmx.rmx_expire;
591 laflags = lle->la_flags;
593 IF_AFDATA_WUNLOCK(ifp);
596 if ((laflags & LLE_PUB) && dst->sa_family == AF_INET)
598 &((struct sockaddr_in *)dst)->sin_addr,
599 &((struct sockaddr_in *)dst)->sin_addr,
600 (u_char *)LLADDR(dl));
606 IF_AFDATA_WLOCK(ifp);
607 error = lla_delete(llt, 0, dst);
608 IF_AFDATA_WUNLOCK(ifp);
609 return (error == 0 ? 0 : ENOENT);
622 SLIST_INIT(&V_lltables);
624 VNET_SYSINIT(vnet_lltable_init, SI_SUB_PSEUDO, SI_ORDER_FIRST,
625 vnet_lltable_init, NULL);
630 struct sockaddr l3_addr;
634 llatbl_lle_show(struct llentry_sa *la)
640 db_printf("lle=%p\n", lle);
641 db_printf(" lle_next=%p\n", lle->lle_next.le_next);
642 db_printf(" lle_lock=%p\n", &lle->lle_lock);
643 db_printf(" lle_tbl=%p\n", lle->lle_tbl);
644 db_printf(" lle_head=%p\n", lle->lle_head);
645 db_printf(" la_hold=%p\n", lle->la_hold);
646 db_printf(" la_numheld=%d\n", lle->la_numheld);
647 db_printf(" la_expire=%ju\n", (uintmax_t)lle->la_expire);
648 db_printf(" la_flags=0x%04x\n", lle->la_flags);
649 db_printf(" la_asked=%u\n", lle->la_asked);
650 db_printf(" la_preempt=%u\n", lle->la_preempt);
651 db_printf(" ln_byhint=%u\n", lle->ln_byhint);
652 db_printf(" ln_state=%d\n", lle->ln_state);
653 db_printf(" ln_router=%u\n", lle->ln_router);
654 db_printf(" ln_ntick=%ju\n", (uintmax_t)lle->ln_ntick);
655 db_printf(" lle_refcnt=%d\n", lle->lle_refcnt);
656 bcopy(&lle->ll_addr.mac16, octet, sizeof(octet));
657 db_printf(" ll_addr=%02x:%02x:%02x:%02x:%02x:%02x\n",
658 octet[0], octet[1], octet[2], octet[3], octet[4], octet[5]);
659 db_printf(" lle_timer=%p\n", &lle->lle_timer);
661 switch (la->l3_addr.sa_family) {
665 struct sockaddr_in *sin;
666 char l3s[INET_ADDRSTRLEN];
668 sin = (struct sockaddr_in *)&la->l3_addr;
669 inet_ntoa_r(sin->sin_addr, l3s);
670 db_printf(" l3_addr=%s\n", l3s);
677 struct sockaddr_in6 *sin6;
678 char l3s[INET6_ADDRSTRLEN];
680 sin6 = (struct sockaddr_in6 *)&la->l3_addr;
681 ip6_sprintf(l3s, &sin6->sin6_addr);
682 db_printf(" l3_addr=%s\n", l3s);
687 db_printf(" l3_addr=N/A (af=%d)\n", la->l3_addr.sa_family);
692 DB_SHOW_COMMAND(llentry, db_show_llentry)
696 db_printf("usage: show llentry <struct llentry *>\n");
700 llatbl_lle_show((struct llentry_sa *)addr);
704 llatbl_llt_show(struct lltable *llt)
709 db_printf("llt=%p llt_af=%d llt_ifp=%p\n",
710 llt, llt->llt_af, llt->llt_ifp);
712 for (i = 0; i < llt->llt_hsize; i++) {
713 LIST_FOREACH(lle, &llt->lle_head[i], lle_next) {
715 llatbl_lle_show((struct llentry_sa *)lle);
722 DB_SHOW_COMMAND(lltable, db_show_lltable)
726 db_printf("usage: show lltable <struct lltable *>\n");
730 llatbl_llt_show((struct lltable *)addr);
733 DB_SHOW_ALL_COMMAND(lltables, db_show_all_lltables)
735 VNET_ITERATOR_DECL(vnet_iter);
738 VNET_FOREACH(vnet_iter) {
739 CURVNET_SET_QUIET(vnet_iter);
741 db_printf("vnet=%p\n", curvnet);
743 SLIST_FOREACH(llt, &V_lltables, llt_link) {
744 db_printf("llt=%p llt_af=%d llt_ifp=%p(%s)\n",
745 llt, llt->llt_af, llt->llt_ifp,
746 (llt->llt_ifp != NULL) ?
747 llt->llt_ifp->if_xname : "?");
748 if (have_addr && addr != 0) /* verbose */
749 llatbl_llt_show(llt);