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