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 llentries_unlink(struct lltable *llt, struct llentries *head);
75 static void htable_unlink_entry(struct llentry *lle);
76 static void htable_link_entry(struct lltable *llt, struct llentry *lle);
77 static int htable_foreach_lle(struct lltable *llt, llt_foreach_cb_t *f,
81 * Dump lle state for a specific address family.
84 lltable_dump_af(struct lltable *llt, struct sysctl_req *wr)
88 LLTABLE_LOCK_ASSERT();
90 if (llt->llt_ifp->if_flags & IFF_LOOPBACK)
94 IF_AFDATA_RLOCK(llt->llt_ifp);
95 error = lltable_foreach_lle(llt,
96 (llt_foreach_cb_t *)llt->llt_dump_entry, wr);
97 IF_AFDATA_RUNLOCK(llt->llt_ifp);
103 * Dump arp state for a specific address family.
106 lltable_sysctl_dumparp(int af, struct sysctl_req *wr)
112 SLIST_FOREACH(llt, &V_lltables, llt_link) {
113 if (llt->llt_af == af) {
114 error = lltable_dump_af(llt, wr);
125 * Common function helpers for chained hash table.
129 * Runs specified callback for each entry in @llt.
130 * Caller does the locking.
134 htable_foreach_lle(struct lltable *llt, llt_foreach_cb_t *f, void *farg)
136 struct llentry *lle, *next;
141 for (i = 0; i < LLTBL_HASHTBL_SIZE; i++) {
142 LIST_FOREACH_SAFE(lle, &llt->lle_head[i], lle_next, next) {
143 error = f(llt, lle, farg);
153 htable_link_entry(struct lltable *llt, struct llentry *lle)
155 struct llentries *lleh;
158 if ((lle->la_flags & LLE_LINKED) != 0)
161 IF_AFDATA_WLOCK_ASSERT(llt->llt_ifp);
163 hashidx = llt->llt_hash(lle, LLTBL_HASHTBL_SIZE);
164 lleh = &llt->lle_head[hashidx];
167 lle->lle_head = lleh;
168 lle->la_flags |= LLE_LINKED;
169 LIST_INSERT_HEAD(lleh, lle, lle_next);
173 htable_unlink_entry(struct llentry *lle)
176 if ((lle->la_flags & LLE_LINKED) != 0) {
177 IF_AFDATA_WLOCK_ASSERT(lle->lle_tbl->llt_ifp);
178 LIST_REMOVE(lle, lle_next);
179 lle->la_flags &= ~(LLE_VALID | LLE_LINKED);
182 lle->lle_head = NULL;
187 struct prefix_match_data {
188 const struct sockaddr *prefix;
189 const struct sockaddr *mask;
190 struct llentries dchain;
195 htable_prefix_free_cb(struct lltable *llt, struct llentry *lle, void *farg)
197 struct prefix_match_data *pmd;
199 pmd = (struct prefix_match_data *)farg;
201 if (llt->llt_match_prefix(pmd->prefix, pmd->mask, pmd->flags, lle)) {
203 LIST_INSERT_HEAD(&pmd->dchain, lle, lle_chain);
210 htable_prefix_free(struct lltable *llt, const struct sockaddr *prefix,
211 const struct sockaddr *mask, u_int flags)
213 struct llentry *lle, *next;
214 struct prefix_match_data pmd;
216 bzero(&pmd, sizeof(pmd));
220 LIST_INIT(&pmd.dchain);
222 IF_AFDATA_WLOCK(llt->llt_ifp);
223 /* Push matching lles to chain */
224 lltable_foreach_lle(llt, htable_prefix_free_cb, &pmd);
226 llentries_unlink(llt, &pmd.dchain);
227 IF_AFDATA_WUNLOCK(llt->llt_ifp);
229 LIST_FOREACH_SAFE(lle, &pmd.dchain, lle_chain, next)
230 llt->llt_free_entry(llt, lle);
234 llentries_unlink(struct lltable *llt, struct llentries *head)
236 struct llentry *lle, *next;
238 LIST_FOREACH_SAFE(lle, head, lle_chain, next)
239 llt->llt_unlink_entry(lle);
243 * Helper function used to drop all mbufs in hold queue.
245 * Returns the number of held packets, if any, that were dropped.
248 lltable_drop_entry_queue(struct llentry *lle)
253 LLE_WLOCK_ASSERT(lle);
256 while ((lle->la_numheld > 0) && (lle->la_hold != NULL)) {
257 next = lle->la_hold->m_nextpkt;
258 m_freem(lle->la_hold);
264 KASSERT(lle->la_numheld == 0,
265 ("%s: la_numheld %d > 0, pkts_droped %zd", __func__,
266 lle->la_numheld, pkts_dropped));
268 return (pkts_dropped);
272 * Deletes an address from the address table.
273 * This function is called by the timer functions
274 * such as arptimer() and nd6_llinfo_timer(), and
275 * the caller does the locking.
277 * Returns the number of held packets, if any, that were dropped.
280 llentry_free(struct llentry *lle)
285 LLE_WLOCK_ASSERT(lle);
287 if ((lle->la_flags & LLE_LINKED) != 0) {
290 IF_AFDATA_WLOCK_ASSERT(llt->llt_ifp);
291 llt->llt_unlink_entry(lle);
294 pkts_dropped = lltable_drop_entry_queue(lle);
296 LLE_FREE_LOCKED(lle);
298 return (pkts_dropped);
302 * (al)locate an llentry for address dst (equivalent to rtalloc for new-arp).
304 * If found the llentry * is returned referenced and unlocked.
307 llentry_alloc(struct ifnet *ifp, struct lltable *lt,
308 struct sockaddr_storage *dst)
312 IF_AFDATA_RLOCK(ifp);
313 la = lla_lookup(lt, LLE_EXCLUSIVE, (struct sockaddr *)dst);
314 IF_AFDATA_RUNLOCK(ifp);
316 (ifp->if_flags & (IFF_NOARP | IFF_STATICARP)) == 0) {
317 IF_AFDATA_WLOCK(ifp);
318 la = lla_create(lt, 0, (struct sockaddr *)dst);
319 IF_AFDATA_WUNLOCK(ifp);
331 * Free all entries from given table and free itself.
335 lltable_free_cb(struct lltable *llt, struct llentry *lle, void *farg)
337 struct llentries *dchain;
339 dchain = (struct llentries *)farg;
342 LIST_INSERT_HEAD(dchain, lle, lle_chain);
348 * Free all entries from given table and free itself.
351 lltable_free(struct lltable *llt)
353 struct llentry *lle, *next;
354 struct llentries dchain;
356 KASSERT(llt != NULL, ("%s: llt is NULL", __func__));
359 SLIST_REMOVE(&V_lltables, llt, lltable, llt_link);
363 IF_AFDATA_WLOCK(llt->llt_ifp);
364 /* Push all lles to @dchain */
365 lltable_foreach_lle(llt, lltable_free_cb, &dchain);
366 llentries_unlink(llt, &dchain);
367 IF_AFDATA_WUNLOCK(llt->llt_ifp);
369 LIST_FOREACH_SAFE(lle, &dchain, lle_chain, next) {
370 if (callout_stop(&lle->la_timer))
375 free(llt, M_LLTABLE);
380 lltable_drain(int af)
387 SLIST_FOREACH(llt, &V_lltables, llt_link) {
388 if (llt->llt_af != af)
391 for (i=0; i < LLTBL_HASHTBL_SIZE; i++) {
392 LIST_FOREACH(lle, &llt->lle_head[i], lle_next) {
395 m_freem(lle->la_hold);
407 lltable_prefix_free(int af, struct sockaddr *prefix, struct sockaddr *mask,
413 SLIST_FOREACH(llt, &V_lltables, llt_link) {
414 if (llt->llt_af != af)
417 llt->llt_prefix_free(llt, prefix, mask, flags);
423 * Create a new lltable.
426 lltable_init(struct ifnet *ifp, int af)
431 llt = malloc(sizeof(struct lltable), M_LLTABLE, M_WAITOK);
435 for (i = 0; i < LLTBL_HASHTBL_SIZE; i++)
436 LIST_INIT(&llt->lle_head[i]);
438 /* Set some default callbacks */
439 llt->llt_link_entry = htable_link_entry;
440 llt->llt_unlink_entry = htable_unlink_entry;
441 llt->llt_prefix_free = htable_prefix_free;
442 llt->llt_foreach_entry = htable_foreach_lle;
445 SLIST_INSERT_HEAD(&V_lltables, llt, llt_link);
452 * External methods used by lltable consumers
456 lltable_foreach_lle(struct lltable *llt, llt_foreach_cb_t *f, void *farg)
459 return (llt->llt_foreach_entry(llt, f, farg));
463 lltable_link_entry(struct lltable *llt, struct llentry *lle)
466 llt->llt_link_entry(llt, lle);
470 lltable_unlink_entry(struct lltable *llt, struct llentry *lle)
473 llt->llt_unlink_entry(lle);
477 lltable_fill_sa_entry(const struct llentry *lle, struct sockaddr *sa)
482 llt->llt_fill_sa_entry(lle, sa);
486 lltable_get_ifp(const struct lltable *llt)
489 return (llt->llt_ifp);
493 lltable_get_af(const struct lltable *llt)
496 return (llt->llt_af);
500 * Called in route_output when rtm_flags contains RTF_LLDATA.
503 lla_rt_output(struct rt_msghdr *rtm, struct rt_addrinfo *info)
505 struct sockaddr_dl *dl =
506 (struct sockaddr_dl *)info->rti_info[RTAX_GATEWAY];
507 struct sockaddr *dst = (struct sockaddr *)info->rti_info[RTAX_DST];
514 KASSERT(dl != NULL && dl->sdl_family == AF_LINK,
515 ("%s: invalid dl\n", __func__));
517 ifp = ifnet_byindex(dl->sdl_index);
519 log(LOG_INFO, "%s: invalid ifp (sdl_index %d)\n",
520 __func__, dl->sdl_index);
524 /* XXX linked list may be too expensive */
526 SLIST_FOREACH(llt, &V_lltables, llt_link) {
527 if (llt->llt_af == dst->sa_family &&
532 KASSERT(llt != NULL, ("Yep, ugly hacks are bad\n"));
536 switch (rtm->rtm_type) {
539 IF_AFDATA_WLOCK(ifp);
540 lle = lla_create(llt, 0, dst);
542 IF_AFDATA_WUNLOCK(ifp);
547 bcopy(LLADDR(dl), &lle->ll_addr, ifp->if_addrlen);
548 if ((rtm->rtm_flags & RTF_ANNOUNCE))
549 lle->la_flags |= LLE_PUB;
550 lle->la_flags |= LLE_VALID;
555 if (dst->sa_family == AF_INET6)
556 lle->ln_state = ND6_LLINFO_REACHABLE;
559 * NB: arp and ndp always set (RTF_STATIC | RTF_HOST)
562 if (rtm->rtm_rmx.rmx_expire == 0) {
563 lle->la_flags |= LLE_STATIC;
566 lle->la_expire = rtm->rtm_rmx.rmx_expire;
567 laflags = lle->la_flags;
569 IF_AFDATA_WUNLOCK(ifp);
572 if ((laflags & LLE_PUB) && dst->sa_family == AF_INET)
574 &((struct sockaddr_in *)dst)->sin_addr,
575 &((struct sockaddr_in *)dst)->sin_addr,
576 (u_char *)LLADDR(dl));
582 IF_AFDATA_WLOCK(ifp);
583 error = lla_delete(llt, 0, dst);
584 IF_AFDATA_WUNLOCK(ifp);
585 return (error == 0 ? 0 : ENOENT);
598 SLIST_INIT(&V_lltables);
600 VNET_SYSINIT(vnet_lltable_init, SI_SUB_PSEUDO, SI_ORDER_FIRST,
601 vnet_lltable_init, NULL);
606 struct sockaddr l3_addr;
610 llatbl_lle_show(struct llentry_sa *la)
616 db_printf("lle=%p\n", lle);
617 db_printf(" lle_next=%p\n", lle->lle_next.le_next);
618 db_printf(" lle_lock=%p\n", &lle->lle_lock);
619 db_printf(" lle_tbl=%p\n", lle->lle_tbl);
620 db_printf(" lle_head=%p\n", lle->lle_head);
621 db_printf(" la_hold=%p\n", lle->la_hold);
622 db_printf(" la_numheld=%d\n", lle->la_numheld);
623 db_printf(" la_expire=%ju\n", (uintmax_t)lle->la_expire);
624 db_printf(" la_flags=0x%04x\n", lle->la_flags);
625 db_printf(" la_asked=%u\n", lle->la_asked);
626 db_printf(" la_preempt=%u\n", lle->la_preempt);
627 db_printf(" ln_byhint=%u\n", lle->ln_byhint);
628 db_printf(" ln_state=%d\n", lle->ln_state);
629 db_printf(" ln_router=%u\n", lle->ln_router);
630 db_printf(" ln_ntick=%ju\n", (uintmax_t)lle->ln_ntick);
631 db_printf(" lle_refcnt=%d\n", lle->lle_refcnt);
632 bcopy(&lle->ll_addr.mac16, octet, sizeof(octet));
633 db_printf(" ll_addr=%02x:%02x:%02x:%02x:%02x:%02x\n",
634 octet[0], octet[1], octet[2], octet[3], octet[4], octet[5]);
635 db_printf(" la_timer=%p\n", &lle->la_timer);
637 switch (la->l3_addr.sa_family) {
641 struct sockaddr_in *sin;
642 char l3s[INET_ADDRSTRLEN];
644 sin = (struct sockaddr_in *)&la->l3_addr;
645 inet_ntoa_r(sin->sin_addr, l3s);
646 db_printf(" l3_addr=%s\n", l3s);
653 struct sockaddr_in6 *sin6;
654 char l3s[INET6_ADDRSTRLEN];
656 sin6 = (struct sockaddr_in6 *)&la->l3_addr;
657 ip6_sprintf(l3s, &sin6->sin6_addr);
658 db_printf(" l3_addr=%s\n", l3s);
663 db_printf(" l3_addr=N/A (af=%d)\n", la->l3_addr.sa_family);
668 DB_SHOW_COMMAND(llentry, db_show_llentry)
672 db_printf("usage: show llentry <struct llentry *>\n");
676 llatbl_lle_show((struct llentry_sa *)addr);
680 llatbl_llt_show(struct lltable *llt)
685 db_printf("llt=%p llt_af=%d llt_ifp=%p\n",
686 llt, llt->llt_af, llt->llt_ifp);
688 for (i = 0; i < LLTBL_HASHTBL_SIZE; i++) {
689 LIST_FOREACH(lle, &llt->lle_head[i], lle_next) {
691 llatbl_lle_show((struct llentry_sa *)lle);
698 DB_SHOW_COMMAND(lltable, db_show_lltable)
702 db_printf("usage: show lltable <struct lltable *>\n");
706 llatbl_llt_show((struct lltable *)addr);
709 DB_SHOW_ALL_COMMAND(lltables, db_show_all_lltables)
711 VNET_ITERATOR_DECL(vnet_iter);
714 VNET_FOREACH(vnet_iter) {
715 CURVNET_SET_QUIET(vnet_iter);
717 db_printf("vnet=%p\n", curvnet);
719 SLIST_FOREACH(llt, &V_lltables, llt_link) {
720 db_printf("llt=%p llt_af=%d llt_ifp=%p(%s)\n",
721 llt, llt->llt_af, llt->llt_ifp,
722 (llt->llt_ifp != NULL) ?
723 llt->llt_ifp->if_xname : "?");
724 if (have_addr && addr != 0) /* verbose */
725 llatbl_llt_show(llt);