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