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