sys/net/if_llatbl.c

   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  * Returns the number of held packets, if any, that were dropped.
 105  */
 106 size_t
 107 llentry_free(struct llentry *lle)
 108 {
 109         size_t pkts_dropped;
 110         struct mbuf *next;
 111
 112         IF_AFDATA_WLOCK_ASSERT(lle->lle_tbl->llt_ifp);
 113         LLE_WLOCK_ASSERT(lle);
 114
 115         LIST_REMOVE(lle, lle_next);
 116         lle->la_flags &= ~(LLE_VALID | LLE_LINKED);
 117
 118         pkts_dropped = 0;
 119         while ((lle->la_numheld > 0) && (lle->la_hold != NULL)) {
 120                 next = lle->la_hold->m_nextpkt;
 121                 m_freem(lle->la_hold);
 122                 lle->la_hold = next;
 123                 lle->la_numheld--;
 124                 pkts_dropped++;
 125         }
 126
 127         KASSERT(lle->la_numheld == 0,
 128                 ("%s: la_numheld %d > 0, pkts_droped %zd", __func__,
 129                  lle->la_numheld, pkts_dropped));
 130
 131         LLE_FREE_LOCKED(lle);
 132
 133         return (pkts_dropped);
 134 }
 135
 136 /*
 137  * (al)locate an llentry for address dst (equivalent to rtalloc for new-arp).
 138  *
 139  * If found the llentry * is returned referenced and unlocked.
 140  */
 141 struct llentry *
 142 llentry_alloc(struct ifnet *ifp, struct lltable *lt,
 143     struct sockaddr_storage *dst)
 144 {
 145         struct llentry *la;
 146
 147         IF_AFDATA_RLOCK(ifp);
 148         la = lla_lookup(lt, LLE_EXCLUSIVE, (struct sockaddr *)dst);
 149         IF_AFDATA_RUNLOCK(ifp);
 150         if ((la == NULL) &&
 151             (ifp->if_flags & (IFF_NOARP | IFF_STATICARP)) == 0) {
 152                 IF_AFDATA_WLOCK(ifp);
 153                 la = lla_lookup(lt, (LLE_CREATE | LLE_EXCLUSIVE),
 154                     (struct sockaddr *)dst);
 155                 IF_AFDATA_WUNLOCK(ifp);
 156         }
 157
 158         if (la != NULL) {
 159                 LLE_ADDREF(la);
 160                 LLE_WUNLOCK(la);
 161         }
 162
 163         return (la);
 164 }
 165
 166 /*
 167  * Free all entries from given table and free itself.
 168  */
 169 void
 170 lltable_free(struct lltable *llt)
 171 {
 172         struct llentry *lle, *next;
 173         int i;
 174
 175         KASSERT(llt != NULL, ("%s: llt is NULL", __func__));
 176
 177         LLTABLE_WLOCK();
 178         SLIST_REMOVE(&V_lltables, llt, lltable, llt_link);
 179         LLTABLE_WUNLOCK();
 180
 181         IF_AFDATA_WLOCK(llt->llt_ifp);
 182         for (i = 0; i < LLTBL_HASHTBL_SIZE; i++) {
 183                 LIST_FOREACH_SAFE(lle, &llt->lle_head[i], lle_next, next) {
 184                         LLE_WLOCK(lle);
 185                         if (callout_stop(&lle->la_timer))
 186                                 LLE_REMREF(lle);
 187                         llentry_free(lle);
 188                 }
 189         }
 190         IF_AFDATA_WUNLOCK(llt->llt_ifp);
 191
 192         free(llt, M_LLTABLE);
 193 }
 194
 195 #if 0
 196 void
 197 lltable_drain(int af)
 198 {
 199         struct lltable  *llt;
 200         struct llentry  *lle;
 201         register int i;
 202
 203         LLTABLE_RLOCK();
 204         SLIST_FOREACH(llt, &V_lltables, llt_link) {
 205                 if (llt->llt_af != af)
 206                         continue;
 207
 208                 for (i=0; i < LLTBL_HASHTBL_SIZE; i++) {
 209                         LIST_FOREACH(lle, &llt->lle_head[i], lle_next) {
 210                                 LLE_WLOCK(lle);
 211                                 if (lle->la_hold) {
 212                                         m_freem(lle->la_hold);
 213                                         lle->la_hold = NULL;
 214                                 }
 215                                 LLE_WUNLOCK(lle);
 216                         }
 217                 }
 218         }
 219         LLTABLE_RUNLOCK();
 220 }
 221 #endif
 222
 223 void
 224 lltable_prefix_free(int af, struct sockaddr *prefix, struct sockaddr *mask,
 225     u_int flags)
 226 {
 227         struct lltable *llt;
 228
 229         LLTABLE_RLOCK();
 230         SLIST_FOREACH(llt, &V_lltables, llt_link) {
 231                 if (llt->llt_af != af)
 232                         continue;
 233
 234                 llt->llt_prefix_free(llt, prefix, mask, flags);
 235         }
 236         LLTABLE_RUNLOCK();
 237 }
 238
 239
 240
 241 /*
 242  * Create a new lltable.
 243  */
 244 struct lltable *
 245 lltable_init(struct ifnet *ifp, int af)
 246 {
 247         struct lltable *llt;
 248         register int i;
 249
 250         llt = malloc(sizeof(struct lltable), M_LLTABLE, M_WAITOK);
 251
 252         llt->llt_af = af;
 253         llt->llt_ifp = ifp;
 254         for (i = 0; i < LLTBL_HASHTBL_SIZE; i++)
 255                 LIST_INIT(&llt->lle_head[i]);
 256
 257         LLTABLE_WLOCK();
 258         SLIST_INSERT_HEAD(&V_lltables, llt, llt_link);
 259         LLTABLE_WUNLOCK();
 260
 261         return (llt);
 262 }
 263
 264 /*
 265  * Called in route_output when adding/deleting a route to an interface.
 266  */
 267 int
 268 lla_rt_output(struct rt_msghdr *rtm, struct rt_addrinfo *info)
 269 {
 270         struct sockaddr_dl *dl =
 271             (struct sockaddr_dl *)info->rti_info[RTAX_GATEWAY];
 272         struct sockaddr *dst = (struct sockaddr *)info->rti_info[RTAX_DST];
 273         struct ifnet *ifp;
 274         struct lltable *llt;
 275         struct llentry *lle;
 276         u_int laflags = 0, flags = 0;
 277         int error = 0;
 278
 279         if (dl == NULL || dl->sdl_family != AF_LINK) {
 280                 log(LOG_INFO, "%s: invalid dl\n", __func__);
 281                 return EINVAL;
 282         }
 283         ifp = ifnet_byindex(dl->sdl_index);
 284         if (ifp == NULL) {
 285                 log(LOG_INFO, "%s: invalid ifp (sdl_index %d)\n",
 286                     __func__, dl->sdl_index);
 287                 return EINVAL;
 288         }
 289
 290         switch (rtm->rtm_type) {
 291         case RTM_ADD:
 292                 if (rtm->rtm_flags & RTF_ANNOUNCE) {
 293                         flags |= LLE_PUB;
 294 #ifdef INET
 295                         if (dst->sa_family == AF_INET &&
 296                             ((struct sockaddr_inarp *)dst)->sin_other != 0) {
 297                                 struct rtentry *rt;
 298                                 ((struct sockaddr_inarp *)dst)->sin_other = 0;
 299                                 rt = rtalloc1(dst, 0, 0);
 300                                 if (rt == NULL || !(rt->rt_flags & RTF_HOST)) {
 301                                         log(LOG_INFO, "%s: RTM_ADD publish "
 302                                             "(proxy only) is invalid\n",
 303                                             __func__);
 304                                         if (rt)
 305                                                 RTFREE_LOCKED(rt);
 306                                         return EINVAL;
 307                                 }
 308                                 RTFREE_LOCKED(rt);
 309
 310                                 flags |= LLE_PROXY;
 311                         }
 312 #endif
 313                 }
 314                 flags |= LLE_CREATE;
 315                 break;
 316
 317         case RTM_DELETE:
 318                 flags |= LLE_DELETE;
 319                 break;
 320
 321         case RTM_CHANGE:
 322                 break;
 323
 324         default:
 325                 return EINVAL; /* XXX not implemented yet */
 326         }
 327
 328         /* XXX linked list may be too expensive */
 329         LLTABLE_RLOCK();
 330         SLIST_FOREACH(llt, &V_lltables, llt_link) {
 331                 if (llt->llt_af == dst->sa_family &&
 332                     llt->llt_ifp == ifp)
 333                         break;
 334         }
 335         LLTABLE_RUNLOCK();
 336         KASSERT(llt != NULL, ("Yep, ugly hacks are bad\n"));
 337
 338         if (flags & LLE_CREATE)
 339                 flags |= LLE_EXCLUSIVE;
 340
 341         IF_AFDATA_LOCK(ifp);
 342         lle = lla_lookup(llt, flags, dst);
 343         IF_AFDATA_UNLOCK(ifp);
 344         if (LLE_IS_VALID(lle)) {
 345                 if (flags & LLE_CREATE) {
 346                         /*
 347                          * If we delay the delete, then a subsequent
 348                          * "arp add" should look up this entry, reset the
 349                          * LLE_DELETED flag, and reset the expiration timer
 350                          */
 351                         bcopy(LLADDR(dl), &lle->ll_addr, ifp->if_addrlen);
 352                         lle->la_flags |= (flags & (LLE_PUB | LLE_PROXY));
 353                         lle->la_flags |= LLE_VALID;
 354                         lle->la_flags &= ~LLE_DELETED;
 355 #ifdef INET6
 356                         /*
 357                          * ND6
 358                          */
 359                         if (dst->sa_family == AF_INET6)
 360                                 lle->ln_state = ND6_LLINFO_REACHABLE;
 361 #endif
 362                         /*
 363                          * NB: arp and ndp always set (RTF_STATIC | RTF_HOST)
 364                          */
 365
 366                         if (rtm->rtm_rmx.rmx_expire == 0) {
 367                                 lle->la_flags |= LLE_STATIC;
 368                                 lle->la_expire = 0;
 369                         } else
 370                                 lle->la_expire = rtm->rtm_rmx.rmx_expire;
 371                         laflags = lle->la_flags;
 372                         LLE_WUNLOCK(lle);
 373 #ifdef INET
 374                         /*  gratuitous ARP */
 375                         if ((laflags & LLE_PUB) && dst->sa_family == AF_INET) {
 376                                 arprequest(ifp,
 377                                     &((struct sockaddr_in *)dst)->sin_addr,
 378                                     &((struct sockaddr_in *)dst)->sin_addr,
 379                                     ((laflags & LLE_PROXY) ?
 380                                         (u_char *)IF_LLADDR(ifp) :
 381                                         (u_char *)LLADDR(dl)));
 382                         }
 383 #endif
 384                 } else {
 385                         if (flags & LLE_EXCLUSIVE)
 386                                 LLE_WUNLOCK(lle);
 387                         else
 388                                 LLE_RUNLOCK(lle);
 389                 }
 390         } else if ((lle == NULL) && (flags & LLE_DELETE))
 391                 error = EINVAL;
 392
 393
 394         return (error);
 395 }
 396
 397 static void
 398 vnet_lltable_init()
 399 {
 400
 401         SLIST_INIT(&V_lltables);
 402 }
 403 VNET_SYSINIT(vnet_lltable_init, SI_SUB_PSEUDO, SI_ORDER_FIRST,
 404     vnet_lltable_init, NULL);
 405
 406 #ifdef DDB
 407 struct llentry_sa {
 408         struct llentry          base;
 409         struct sockaddr         l3_addr;
 410 };
 411
 412 static void
 413 llatbl_lle_show(struct llentry_sa *la)
 414 {
 415         struct llentry *lle;
 416         uint8_t octet[6];
 417
 418         lle = &la->base;
 419         db_printf("lle=%p\n", lle);
 420         db_printf(" lle_next=%p\n", lle->lle_next.le_next);
 421         db_printf(" lle_lock=%p\n", &lle->lle_lock);
 422         db_printf(" lle_tbl=%p\n", lle->lle_tbl);
 423         db_printf(" lle_head=%p\n", lle->lle_head);
 424         db_printf(" la_hold=%p\n", lle->la_hold);
 425         db_printf(" la_numheld=%d\n", lle->la_numheld);
 426         db_printf(" la_expire=%ju\n", (uintmax_t)lle->la_expire);
 427         db_printf(" la_flags=0x%04x\n", lle->la_flags);
 428         db_printf(" la_asked=%u\n", lle->la_asked);
 429         db_printf(" la_preempt=%u\n", lle->la_preempt);
 430         db_printf(" ln_byhint=%u\n", lle->ln_byhint);
 431         db_printf(" ln_state=%d\n", lle->ln_state);
 432         db_printf(" ln_router=%u\n", lle->ln_router);
 433         db_printf(" ln_ntick=%ju\n", (uintmax_t)lle->ln_ntick);
 434         db_printf(" lle_refcnt=%d\n", lle->lle_refcnt);
 435         bcopy(&lle->ll_addr.mac16, octet, sizeof(octet));
 436         db_printf(" ll_addr=%02x:%02x:%02x:%02x:%02x:%02x\n",
 437             octet[0], octet[1], octet[2], octet[3], octet[4], octet[5]);
 438         db_printf(" la_timer=%p\n", &lle->la_timer);
 439
 440         switch (la->l3_addr.sa_family) {
 441 #ifdef INET
 442         case AF_INET:
 443         {
 444                 struct sockaddr_in *sin;
 445                 char l3s[INET_ADDRSTRLEN];
 446
 447                 sin = (struct sockaddr_in *)&la->l3_addr;
 448                 inet_ntoa_r(sin->sin_addr, l3s);
 449                 db_printf(" l3_addr=%s\n", l3s);
 450                 break;
 451         }
 452 #endif
 453 #ifdef INET6
 454         case AF_INET6:
 455         {
 456                 struct sockaddr_in6 *sin6;
 457                 char l3s[INET6_ADDRSTRLEN];
 458
 459                 sin6 = (struct sockaddr_in6 *)&la->l3_addr;
 460                 ip6_sprintf(l3s, &sin6->sin6_addr);
 461                 db_printf(" l3_addr=%s\n", l3s);
 462                 break;
 463         }
 464 #endif
 465         default:
 466                 db_printf(" l3_addr=N/A (af=%d)\n", la->l3_addr.sa_family);
 467                 break;
 468         }
 469 }
 470
 471 DB_SHOW_COMMAND(llentry, db_show_llentry)
 472 {
 473
 474         if (!have_addr) {
 475                 db_printf("usage: show llentry <struct llentry *>\n");
 476                 return;
 477         }
 478
 479         llatbl_lle_show((struct llentry_sa *)addr);
 480 }
 481
 482 static void
 483 llatbl_llt_show(struct lltable *llt)
 484 {
 485         int i;
 486         struct llentry *lle;
 487
 488         db_printf("llt=%p llt_af=%d llt_ifp=%p\n",
 489             llt, llt->llt_af, llt->llt_ifp);
 490
 491         for (i = 0; i < LLTBL_HASHTBL_SIZE; i++) {
 492                 LIST_FOREACH(lle, &llt->lle_head[i], lle_next) {
 493
 494                         llatbl_lle_show((struct llentry_sa *)lle);
 495                         if (db_pager_quit)
 496                                 return;
 497                 }
 498         }
 499 }
 500
 501 DB_SHOW_COMMAND(lltable, db_show_lltable)
 502 {
 503
 504         if (!have_addr) {
 505                 db_printf("usage: show lltable <struct lltable *>\n");
 506                 return;
 507         }
 508
 509         llatbl_llt_show((struct lltable *)addr);
 510 }
 511
 512 DB_SHOW_ALL_COMMAND(lltables, db_show_all_lltables)
 513 {
 514         VNET_ITERATOR_DECL(vnet_iter);
 515         struct lltable *llt;
 516
 517         VNET_FOREACH(vnet_iter) {
 518                 CURVNET_SET_QUIET(vnet_iter);
 519 #ifdef VIMAGE
 520                 db_printf("vnet=%p\n", curvnet);
 521 #endif
 522                 SLIST_FOREACH(llt, &V_lltables, llt_link) {
 523                         db_printf("llt=%p llt_af=%d llt_ifp=%p(%s)\n",
 524                             llt, llt->llt_af, llt->llt_ifp,
 525                             (llt->llt_ifp != NULL) ?
 526                                 llt->llt_ifp->if_xname : "?");
 527                         if (have_addr && addr != 0) /* verbose */
 528                                 llatbl_llt_show(llt);
 529                         if (db_pager_quit) {
 530                                 CURVNET_RESTORE();
 531                                 return;
 532                         }
 533                 }
 534                 CURVNET_RESTORE();
 535         }
 536 }
 537 #endif