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 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
 238         llt->llt_af = af;
 239         llt->llt_ifp = ifp;
 240         for (i = 0; i < LLTBL_HASHTBL_SIZE; i++)
 241                 LIST_INIT(&llt->lle_head[i]);
 242
 243         LLTABLE_WLOCK();
 244         SLIST_INSERT_HEAD(&V_lltables, llt, llt_link);
 245         LLTABLE_WUNLOCK();
 246
 247         return (llt);
 248 }
 249
 250 /*
 251  * Called in route_output when adding/deleting a route to an interface.
 252  */
 253 int
 254 lla_rt_output(struct rt_msghdr *rtm, struct rt_addrinfo *info)
 255 {
 256         struct sockaddr_dl *dl =
 257             (struct sockaddr_dl *)info->rti_info[RTAX_GATEWAY];
 258         struct sockaddr *dst = (struct sockaddr *)info->rti_info[RTAX_DST];
 259         struct ifnet *ifp;
 260         struct lltable *llt;
 261         struct llentry *lle;
 262         u_int laflags = 0, flags = 0;
 263         int error = 0;
 264
 265         if (dl == NULL || dl->sdl_family != AF_LINK) {
 266                 log(LOG_INFO, "%s: invalid dl\n", __func__);
 267                 return EINVAL;
 268         }
 269         ifp = ifnet_byindex(dl->sdl_index);
 270         if (ifp == NULL) {
 271                 log(LOG_INFO, "%s: invalid ifp (sdl_index %d)\n",
 272                     __func__, dl->sdl_index);
 273                 return EINVAL;
 274         }
 275
 276         switch (rtm->rtm_type) {
 277         case RTM_ADD:
 278                 if (rtm->rtm_flags & RTF_ANNOUNCE) {
 279                         flags |= LLE_PUB;
 280 #ifdef INET
 281                         if (dst->sa_family == AF_INET &&
 282                             ((struct sockaddr_inarp *)dst)->sin_other != 0) {
 283                                 struct rtentry *rt;
 284                                 ((struct sockaddr_inarp *)dst)->sin_other = 0;
 285                                 rt = rtalloc1(dst, 0, 0);
 286                                 if (rt == NULL || !(rt->rt_flags & RTF_HOST)) {
 287                                         log(LOG_INFO, "%s: RTM_ADD publish "
 288                                             "(proxy only) is invalid\n",
 289                                             __func__);
 290                                         if (rt)
 291                                                 RTFREE_LOCKED(rt);
 292                                         return EINVAL;
 293                                 }
 294                                 RTFREE_LOCKED(rt);
 295
 296                                 flags |= LLE_PROXY;
 297                         }
 298 #endif
 299                 }
 300                 flags |= LLE_CREATE;
 301                 break;
 302
 303         case RTM_DELETE:
 304                 flags |= LLE_DELETE;
 305                 break;
 306
 307         case RTM_CHANGE:
 308                 break;
 309
 310         default:
 311                 return EINVAL; /* XXX not implemented yet */
 312         }
 313
 314         /* XXX linked list may be too expensive */
 315         LLTABLE_RLOCK();
 316         SLIST_FOREACH(llt, &V_lltables, llt_link) {
 317                 if (llt->llt_af == dst->sa_family &&
 318                     llt->llt_ifp == ifp)
 319                         break;
 320         }
 321         LLTABLE_RUNLOCK();
 322         KASSERT(llt != NULL, ("Yep, ugly hacks are bad\n"));
 323
 324         if (flags & LLE_CREATE)
 325                 flags |= LLE_EXCLUSIVE;
 326
 327         IF_AFDATA_LOCK(ifp);
 328         lle = lla_lookup(llt, flags, dst);
 329         IF_AFDATA_UNLOCK(ifp);
 330         if (LLE_IS_VALID(lle)) {
 331                 if (flags & LLE_CREATE) {
 332                         /*
 333                          * If we delay the delete, then a subsequent
 334                          * "arp add" should look up this entry, reset the
 335                          * LLE_DELETED flag, and reset the expiration timer
 336                          */
 337                         bcopy(LLADDR(dl), &lle->ll_addr, ifp->if_addrlen);
 338                         lle->la_flags |= (flags & (LLE_PUB | LLE_PROXY));
 339                         lle->la_flags |= LLE_VALID;
 340                         lle->la_flags &= ~LLE_DELETED;
 341 #ifdef INET6
 342                         /*
 343                          * ND6
 344                          */
 345                         if (dst->sa_family == AF_INET6)
 346                                 lle->ln_state = ND6_LLINFO_REACHABLE;
 347 #endif
 348                         /*
 349                          * NB: arp and ndp always set (RTF_STATIC | RTF_HOST)
 350                          */
 351
 352                         if (rtm->rtm_rmx.rmx_expire == 0) {
 353                                 lle->la_flags |= LLE_STATIC;
 354                                 lle->la_expire = 0;
 355                         } else
 356                                 lle->la_expire = rtm->rtm_rmx.rmx_expire;
 357                         laflags = lle->la_flags;
 358                         LLE_WUNLOCK(lle);
 359 #ifdef INET
 360                         /*  gratuitous ARP */
 361                         if ((laflags & LLE_PUB) && dst->sa_family == AF_INET) {
 362                                 arprequest(ifp,
 363                                     &((struct sockaddr_in *)dst)->sin_addr,
 364                                     &((struct sockaddr_in *)dst)->sin_addr,
 365                                     ((laflags & LLE_PROXY) ?
 366                                         (u_char *)IF_LLADDR(ifp) :
 367                                         (u_char *)LLADDR(dl)));
 368                         }
 369 #endif
 370                 } else {
 371                         if (flags & LLE_EXCLUSIVE)
 372                                 LLE_WUNLOCK(lle);
 373                         else
 374                                 LLE_RUNLOCK(lle);
 375                 }
 376         } else if ((lle == NULL) && (flags & LLE_DELETE))
 377                 error = EINVAL;
 378
 379
 380         return (error);
 381 }
 382
 383 static void
 384 vnet_lltable_init()
 385 {
 386
 387         SLIST_INIT(&V_lltables);
 388 }
 389 VNET_SYSINIT(vnet_lltable_init, SI_SUB_PSEUDO, SI_ORDER_FIRST,
 390     vnet_lltable_init, NULL);
 391
 392 #ifdef DDB
 393 struct llentry_sa {
 394         struct llentry          base;
 395         struct sockaddr         l3_addr;
 396 };
 397
 398 static void
 399 llatbl_lle_show(struct llentry_sa *la)
 400 {
 401         struct llentry *lle;
 402         uint8_t octet[6];
 403
 404         lle = &la->base;
 405         db_printf("lle=%p\n", lle);
 406         db_printf(" lle_next=%p\n", lle->lle_next.le_next);
 407         db_printf(" lle_lock=%p\n", &lle->lle_lock);
 408         db_printf(" lle_tbl=%p\n", lle->lle_tbl);
 409         db_printf(" lle_head=%p\n", lle->lle_head);
 410         db_printf(" la_hold=%p\n", lle->la_hold);
 411         db_printf(" la_expire=%ju\n", (uintmax_t)lle->la_expire);
 412         db_printf(" la_flags=0x%04x\n", lle->la_flags);
 413         db_printf(" la_asked=%u\n", lle->la_asked);
 414         db_printf(" la_preempt=%u\n", lle->la_preempt);
 415         db_printf(" ln_byhint=%u\n", lle->ln_byhint);
 416         db_printf(" ln_state=%d\n", lle->ln_state);
 417         db_printf(" ln_router=%u\n", lle->ln_router);
 418         db_printf(" ln_ntick=%ju\n", (uintmax_t)lle->ln_ntick);
 419         db_printf(" lle_refcnt=%d\n", lle->lle_refcnt);
 420         bcopy(&lle->ll_addr.mac16, octet, sizeof(octet));
 421         db_printf(" ll_addr=%02x:%02x:%02x:%02x:%02x:%02x\n",
 422             octet[0], octet[1], octet[2], octet[3], octet[4], octet[5]);
 423         db_printf(" la_timer=%p\n", &lle->la_timer);
 424
 425         switch (la->l3_addr.sa_family) {
 426 #ifdef INET
 427         case AF_INET:
 428         {
 429                 struct sockaddr_in *sin;
 430                 char l3s[INET_ADDRSTRLEN];
 431
 432                 sin = (struct sockaddr_in *)&la->l3_addr;
 433                 inet_ntoa_r(sin->sin_addr, l3s);
 434                 db_printf(" l3_addr=%s\n", l3s);
 435                 break;
 436         }
 437 #endif
 438 #ifdef INET6
 439         case AF_INET6:
 440         {
 441                 struct sockaddr_in6 *sin6;
 442                 char l3s[INET6_ADDRSTRLEN];
 443
 444                 sin6 = (struct sockaddr_in6 *)&la->l3_addr;
 445                 ip6_sprintf(l3s, &sin6->sin6_addr);
 446                 db_printf(" l3_addr=%s\n", l3s);
 447                 break;
 448         }
 449 #endif
 450         default:
 451                 db_printf(" l3_addr=N/A (af=%d)\n", la->l3_addr.sa_family);
 452                 break;
 453         }
 454 }
 455
 456 DB_SHOW_COMMAND(llentry, db_show_llentry)
 457 {
 458
 459         if (!have_addr) {
 460                 db_printf("usage: show llentry <struct llentry *>\n");
 461                 return;
 462         }
 463
 464         llatbl_lle_show((struct llentry_sa *)addr);
 465 }
 466
 467 static void
 468 llatbl_llt_show(struct lltable *llt)
 469 {
 470         int i;
 471         struct llentry *lle;
 472
 473         db_printf("llt=%p llt_af=%d llt_ifp=%p\n",
 474             llt, llt->llt_af, llt->llt_ifp);
 475
 476         for (i = 0; i < LLTBL_HASHTBL_SIZE; i++) {
 477                 LIST_FOREACH(lle, &llt->lle_head[i], lle_next) {
 478
 479                         llatbl_lle_show((struct llentry_sa *)lle);
 480                         if (db_pager_quit)
 481                                 return;
 482                 }
 483         }
 484 }
 485
 486 DB_SHOW_COMMAND(lltable, db_show_lltable)
 487 {
 488
 489         if (!have_addr) {
 490                 db_printf("usage: show lltable <struct lltable *>\n");
 491                 return;
 492         }
 493
 494         llatbl_llt_show((struct lltable *)addr);
 495 }
 496
 497 DB_SHOW_ALL_COMMAND(lltables, db_show_all_lltables)
 498 {
 499         VNET_ITERATOR_DECL(vnet_iter);
 500         struct lltable *llt;
 501
 502         VNET_FOREACH(vnet_iter) {
 503                 CURVNET_SET_QUIET(vnet_iter);
 504 #ifdef VIMAGE
 505                 db_printf("vnet=%p\n", curvnet);
 506 #endif
 507                 SLIST_FOREACH(llt, &V_lltables, llt_link) {
 508                         db_printf("llt=%p llt_af=%d llt_ifp=%p(%s)\n",
 509                             llt, llt->llt_af, llt->llt_ifp,
 510                             (llt->llt_ifp != NULL) ?
 511                                 llt->llt_ifp->if_xname : "?");
 512                         if (have_addr && addr != 0) /* verbose */
 513                                 llatbl_llt_show(llt);
 514                         if (db_pager_quit) {
 515                                 CURVNET_RESTORE();
 516                                 return;
 517                         }
 518                 }
 519                 CURVNET_RESTORE();
 520         }
 521 }
 522 #endif