sys/netinet/if_ether.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1988, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)if_ether.c  8.1 (Berkeley) 6/10/93
  32  */
  33
  34 /*
  35  * Ethernet address resolution protocol.
  36  * TODO:
  37  *      add "inuse/lock" bit (or ref. count) along with valid bit
  38  */
  39
  40 #include <sys/cdefs.h>
  41 #include "opt_inet.h"
  42
  43 #include <sys/param.h>
  44 #include <sys/eventhandler.h>
  45 #include <sys/kernel.h>
  46 #include <sys/lock.h>
  47 #include <sys/queue.h>
  48 #include <sys/sysctl.h>
  49 #include <sys/systm.h>
  50 #include <sys/mbuf.h>
  51 #include <sys/malloc.h>
  52 #include <sys/proc.h>
  53 #include <sys/rmlock.h>
  54 #include <sys/socket.h>
  55 #include <sys/syslog.h>
  56
  57 #include <net/if.h>
  58 #include <net/if_var.h>
  59 #include <net/if_dl.h>
  60 #include <net/if_types.h>
  61 #include <net/netisr.h>
  62 #include <net/ethernet.h>
  63 #include <net/route.h>
  64 #include <net/route/nhop.h>
  65 #include <net/vnet.h>
  66
  67 #include <netinet/in.h>
  68 #include <netinet/in_fib.h>
  69 #include <netinet/in_var.h>
  70 #include <net/if_llatbl.h>
  71 #include <netinet/if_ether.h>
  72 #ifdef INET
  73 #include <netinet/ip_carp.h>
  74 #endif
  75
  76 #include <security/mac/mac_framework.h>
  77
  78 #define SIN(s) ((const struct sockaddr_in *)(s))
  79
  80 static struct timeval arp_lastlog;
  81 static int arp_curpps;
  82 static int arp_maxpps = 1;
  83
  84 /* Simple ARP state machine */
  85 enum arp_llinfo_state {
  86         ARP_LLINFO_INCOMPLETE = 0, /* No LLE data */
  87         ARP_LLINFO_REACHABLE,   /* LLE is valid */
  88         ARP_LLINFO_VERIFY,      /* LLE is valid, need refresh */
  89         ARP_LLINFO_DELETED,     /* LLE is deleted */
  90 };
  91
  92 SYSCTL_DECL(_net_link_ether);
  93 static SYSCTL_NODE(_net_link_ether, PF_INET, inet,
  94     CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
  95     "");
  96 static SYSCTL_NODE(_net_link_ether, PF_ARP, arp,
  97     CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
  98     "");
  99
 100 /* timer values */
 101 VNET_DEFINE_STATIC(int, arpt_keep) = (20*60);   /* once resolved, good for 20
 102                                                  * minutes */
 103 VNET_DEFINE_STATIC(int, arp_maxtries) = 5;
 104 VNET_DEFINE_STATIC(int, arp_proxyall) = 0;
 105 VNET_DEFINE_STATIC(int, arpt_down) = 20;        /* keep incomplete entries for
 106                                                  * 20 seconds */
 107 VNET_DEFINE_STATIC(int, arpt_rexmit) = 1;       /* retransmit arp entries, sec*/
 108 VNET_PCPUSTAT_DEFINE(struct arpstat, arpstat);  /* ARP statistics, see if_arp.h */
 109 VNET_PCPUSTAT_SYSINIT(arpstat);
 110
 111 #ifdef VIMAGE
 112 VNET_PCPUSTAT_SYSUNINIT(arpstat);
 113 #endif /* VIMAGE */
 114
 115 VNET_DEFINE_STATIC(int, arp_maxhold) = 16;
 116
 117 #define V_arpt_keep             VNET(arpt_keep)
 118 #define V_arpt_down             VNET(arpt_down)
 119 #define V_arpt_rexmit           VNET(arpt_rexmit)
 120 #define V_arp_maxtries          VNET(arp_maxtries)
 121 #define V_arp_proxyall          VNET(arp_proxyall)
 122 #define V_arp_maxhold           VNET(arp_maxhold)
 123
 124 SYSCTL_INT(_net_link_ether_inet, OID_AUTO, max_age, CTLFLAG_VNET | CTLFLAG_RW,
 125         &VNET_NAME(arpt_keep), 0,
 126         "ARP entry lifetime in seconds");
 127 SYSCTL_INT(_net_link_ether_inet, OID_AUTO, maxtries, CTLFLAG_VNET | CTLFLAG_RW,
 128         &VNET_NAME(arp_maxtries), 0,
 129         "ARP resolution attempts before returning error");
 130 SYSCTL_INT(_net_link_ether_inet, OID_AUTO, proxyall, CTLFLAG_VNET | CTLFLAG_RW,
 131         &VNET_NAME(arp_proxyall), 0,
 132         "Enable proxy ARP for all suitable requests");
 133 SYSCTL_INT(_net_link_ether_inet, OID_AUTO, wait, CTLFLAG_VNET | CTLFLAG_RW,
 134         &VNET_NAME(arpt_down), 0,
 135         "Incomplete ARP entry lifetime in seconds");
 136 SYSCTL_VNET_PCPUSTAT(_net_link_ether_arp, OID_AUTO, stats, struct arpstat,
 137     arpstat, "ARP statistics (struct arpstat, net/if_arp.h)");
 138 SYSCTL_INT(_net_link_ether_inet, OID_AUTO, maxhold, CTLFLAG_VNET | CTLFLAG_RW,
 139         &VNET_NAME(arp_maxhold), 0,
 140         "Number of packets to hold per ARP entry");
 141 SYSCTL_INT(_net_link_ether_inet, OID_AUTO, max_log_per_second,
 142         CTLFLAG_RW, &arp_maxpps, 0,
 143         "Maximum number of remotely triggered ARP messages that can be "
 144         "logged per second");
 145
 146 /*
 147  * Due to the exponential backoff algorithm used for the interval between GARP
 148  * retransmissions, the maximum number of retransmissions is limited for
 149  * sanity. This limit corresponds to a maximum interval between retransmissions
 150  * of 2^16 seconds ~= 18 hours.
 151  *
 152  * Making this limit more dynamic is more complicated than worthwhile,
 153  * especially since sending out GARPs spaced days apart would be of little
 154  * use. A maximum dynamic limit would look something like:
 155  *
 156  * const int max = fls(INT_MAX / hz) - 1;
 157  */
 158 #define MAX_GARP_RETRANSMITS 16
 159 static int sysctl_garp_rexmit(SYSCTL_HANDLER_ARGS);
 160 static int garp_rexmit_count = 0; /* GARP retransmission setting. */
 161
 162 SYSCTL_PROC(_net_link_ether_inet, OID_AUTO, garp_rexmit_count,
 163     CTLTYPE_INT|CTLFLAG_RW|CTLFLAG_MPSAFE,
 164     &garp_rexmit_count, 0, sysctl_garp_rexmit, "I",
 165     "Number of times to retransmit GARP packets;"
 166     " 0 to disable, maximum of 16");
 167
 168 VNET_DEFINE_STATIC(int, arp_log_level) = LOG_INFO;      /* Min. log(9) level. */
 169 #define V_arp_log_level         VNET(arp_log_level)
 170 SYSCTL_INT(_net_link_ether_arp, OID_AUTO, log_level, CTLFLAG_VNET | CTLFLAG_RW,
 171         &VNET_NAME(arp_log_level), 0,
 172         "Minimum log(9) level for recording rate limited arp log messages. "
 173         "The higher will be log more (emerg=0, info=6 (default), debug=7).");
 174 #define ARP_LOG(pri, ...)       do {                                    \
 175         if ((pri) <= V_arp_log_level &&                                 \
 176             ppsratecheck(&arp_lastlog, &arp_curpps, arp_maxpps))        \
 177                 log((pri), "arp: " __VA_ARGS__);                        \
 178 } while (0)
 179
 180 static void     arpintr(struct mbuf *);
 181 static void     arptimer(void *);
 182 #ifdef INET
 183 static void     in_arpinput(struct mbuf *);
 184 #endif
 185
 186 static void arp_check_update_lle(struct arphdr *ah, struct in_addr isaddr,
 187     struct ifnet *ifp, int bridged, struct llentry *la);
 188 static void arp_mark_lle_reachable(struct llentry *la);
 189 static void arp_iflladdr(void *arg __unused, struct ifnet *ifp);
 190
 191 static eventhandler_tag iflladdr_tag;
 192
 193 static const struct netisr_handler arp_nh = {
 194         .nh_name = "arp",
 195         .nh_handler = arpintr,
 196         .nh_proto = NETISR_ARP,
 197         .nh_policy = NETISR_POLICY_SOURCE,
 198 };
 199
 200 /*
 201  * Timeout routine.  Age arp_tab entries periodically.
 202  */
 203 static void
 204 arptimer(void *arg)
 205 {
 206         struct llentry *lle = (struct llentry *)arg;
 207         struct ifnet *ifp;
 208
 209         if (lle->la_flags & LLE_STATIC) {
 210                 return;
 211         }
 212         LLE_WLOCK(lle);
 213         if (callout_pending(&lle->lle_timer)) {
 214                 /*
 215                  * Here we are a bit odd here in the treatment of
 216                  * active/pending. If the pending bit is set, it got
 217                  * rescheduled before I ran. The active
 218                  * bit we ignore, since if it was stopped
 219                  * in ll_tablefree() and was currently running
 220                  * it would have return 0 so the code would
 221                  * not have deleted it since the callout could
 222                  * not be stopped so we want to go through
 223                  * with the delete here now. If the callout
 224                  * was restarted, the pending bit will be back on and
 225                  * we just want to bail since the callout_reset would
 226                  * return 1 and our reference would have been removed
 227                  * by arpresolve() below.
 228                  */
 229                 LLE_WUNLOCK(lle);
 230                 return;
 231         }
 232         ifp = lle->lle_tbl->llt_ifp;
 233         CURVNET_SET(ifp->if_vnet);
 234
 235         switch (lle->ln_state) {
 236         case ARP_LLINFO_REACHABLE:
 237
 238                 /*
 239                  * Expiration time is approaching.
 240                  * Request usage feedback from the datapath.
 241                  * Change state and re-schedule ourselves.
 242                  */
 243                 llentry_request_feedback(lle);
 244                 lle->ln_state = ARP_LLINFO_VERIFY;
 245                 callout_schedule(&lle->lle_timer, hz * V_arpt_rexmit);
 246                 LLE_WUNLOCK(lle);
 247                 CURVNET_RESTORE();
 248                 return;
 249         case ARP_LLINFO_VERIFY:
 250                 if (llentry_get_hittime(lle) > 0 && lle->la_preempt > 0) {
 251                         /* Entry was used, issue refresh request */
 252                         struct epoch_tracker et;
 253                         struct in_addr dst;
 254
 255                         dst = lle->r_l3addr.addr4;
 256                         lle->la_preempt--;
 257                         callout_schedule(&lle->lle_timer, hz * V_arpt_rexmit);
 258                         LLE_WUNLOCK(lle);
 259                         NET_EPOCH_ENTER(et);
 260                         arprequest(ifp, NULL, &dst, NULL);
 261                         NET_EPOCH_EXIT(et);
 262                         CURVNET_RESTORE();
 263                         return;
 264                 }
 265                 /* Nothing happened. Reschedule if not too late */
 266                 if (lle->la_expire > time_uptime) {
 267                         callout_schedule(&lle->lle_timer, hz * V_arpt_rexmit);
 268                         LLE_WUNLOCK(lle);
 269                         CURVNET_RESTORE();
 270                         return;
 271                 }
 272                 break;
 273         case ARP_LLINFO_INCOMPLETE:
 274         case ARP_LLINFO_DELETED:
 275                 break;
 276         }
 277
 278         if ((lle->la_flags & LLE_DELETED) == 0) {
 279                 int evt;
 280
 281                 if (lle->la_flags & LLE_VALID)
 282                         evt = LLENTRY_EXPIRED;
 283                 else
 284                         evt = LLENTRY_TIMEDOUT;
 285                 EVENTHANDLER_INVOKE(lle_event, lle, evt);
 286         }
 287
 288         callout_stop(&lle->lle_timer);
 289
 290         /* XXX: LOR avoidance. We still have ref on lle. */
 291         LLE_WUNLOCK(lle);
 292         IF_AFDATA_LOCK(ifp);
 293         LLE_WLOCK(lle);
 294
 295         /* Guard against race with other llentry_free(). */
 296         if (lle->la_flags & LLE_LINKED) {
 297                 LLE_REMREF(lle);
 298                 lltable_unlink_entry(lle->lle_tbl, lle);
 299         }
 300         IF_AFDATA_UNLOCK(ifp);
 301
 302         size_t pkts_dropped = llentry_free(lle);
 303
 304         ARPSTAT_ADD(dropped, pkts_dropped);
 305         ARPSTAT_INC(timeouts);
 306
 307         CURVNET_RESTORE();
 308 }
 309
 310 /*
 311  * Stores link-layer header for @ifp in format suitable for if_output()
 312  * into buffer @buf. Resulting header length is stored in @bufsize.
 313  *
 314  * Returns 0 on success.
 315  */
 316 static int
 317 arp_fillheader(struct ifnet *ifp, struct arphdr *ah, int bcast, u_char *buf,
 318     size_t *bufsize)
 319 {
 320         struct if_encap_req ereq;
 321         int error;
 322
 323         bzero(buf, *bufsize);
 324         bzero(&ereq, sizeof(ereq));
 325         ereq.buf = buf;
 326         ereq.bufsize = *bufsize;
 327         ereq.rtype = IFENCAP_LL;
 328         ereq.family = AF_ARP;
 329         ereq.lladdr = ar_tha(ah);
 330         ereq.hdata = (u_char *)ah;
 331         if (bcast)
 332                 ereq.flags = IFENCAP_FLAG_BROADCAST;
 333         error = ifp->if_requestencap(ifp, &ereq);
 334         if (error == 0)
 335                 *bufsize = ereq.bufsize;
 336
 337         return (error);
 338 }
 339
 340 /*
 341  * Broadcast an ARP request. Caller specifies:
 342  *      - arp header source ip address
 343  *      - arp header target ip address
 344  *      - arp header source ethernet address
 345  */
 346 static int
 347 arprequest_internal(struct ifnet *ifp, const struct in_addr *sip,
 348     const struct in_addr *tip, u_char *enaddr)
 349 {
 350         struct mbuf *m;
 351         struct arphdr *ah;
 352         struct sockaddr sa;
 353         u_char *carpaddr = NULL;
 354         uint8_t linkhdr[LLE_MAX_LINKHDR];
 355         size_t linkhdrsize;
 356         struct route ro;
 357         int error;
 358
 359         NET_EPOCH_ASSERT();
 360
 361         if (sip == NULL) {
 362                 /*
 363                  * The caller did not supply a source address, try to find
 364                  * a compatible one among those assigned to this interface.
 365                  */
 366                 struct ifaddr *ifa;
 367
 368                 CK_STAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) {
 369                         if (ifa->ifa_addr->sa_family != AF_INET)
 370                                 continue;
 371
 372                         if (ifa->ifa_carp) {
 373                                 if ((*carp_iamatch_p)(ifa, &carpaddr) == 0)
 374                                         continue;
 375                                 sip = &IA_SIN(ifa)->sin_addr;
 376                         } else {
 377                                 carpaddr = NULL;
 378                                 sip = &IA_SIN(ifa)->sin_addr;
 379                         }
 380
 381                         if (0 == ((sip->s_addr ^ tip->s_addr) &
 382                             IA_MASKSIN(ifa)->sin_addr.s_addr))
 383                                 break;  /* found it. */
 384                 }
 385                 if (sip == NULL) {
 386                         printf("%s: cannot find matching address\n", __func__);
 387                         return (EADDRNOTAVAIL);
 388                 }
 389         }
 390         if (enaddr == NULL)
 391                 enaddr = carpaddr ? carpaddr : (u_char *)IF_LLADDR(ifp);
 392
 393         if ((m = m_gethdr(M_NOWAIT, MT_DATA)) == NULL)
 394                 return (ENOMEM);
 395         m->m_len = sizeof(*ah) + 2 * sizeof(struct in_addr) +
 396                 2 * ifp->if_addrlen;
 397         m->m_pkthdr.len = m->m_len;
 398         M_ALIGN(m, m->m_len);
 399         ah = mtod(m, struct arphdr *);
 400         bzero((caddr_t)ah, m->m_len);
 401 #ifdef MAC
 402         mac_netinet_arp_send(ifp, m);
 403 #endif
 404         ah->ar_pro = htons(ETHERTYPE_IP);
 405         ah->ar_hln = ifp->if_addrlen;           /* hardware address length */
 406         ah->ar_pln = sizeof(struct in_addr);    /* protocol address length */
 407         ah->ar_op = htons(ARPOP_REQUEST);
 408         bcopy(enaddr, ar_sha(ah), ah->ar_hln);
 409         bcopy(sip, ar_spa(ah), ah->ar_pln);
 410         bcopy(tip, ar_tpa(ah), ah->ar_pln);
 411         sa.sa_family = AF_ARP;
 412         sa.sa_len = 2;
 413
 414         /* Calculate link header for sending frame */
 415         bzero(&ro, sizeof(ro));
 416         linkhdrsize = sizeof(linkhdr);
 417         error = arp_fillheader(ifp, ah, 1, linkhdr, &linkhdrsize);
 418         if (error != 0 && error != EAFNOSUPPORT) {
 419                 m_freem(m);
 420                 ARP_LOG(LOG_ERR, "Failed to calculate ARP header on %s: %d\n",
 421                     if_name(ifp), error);
 422                 return (error);
 423         }
 424
 425         ro.ro_prepend = linkhdr;
 426         ro.ro_plen = linkhdrsize;
 427         ro.ro_flags = 0;
 428
 429         m->m_flags |= M_BCAST;
 430         m_clrprotoflags(m);     /* Avoid confusing lower layers. */
 431         error = (*ifp->if_output)(ifp, m, &sa, &ro);
 432         ARPSTAT_INC(txrequests);
 433         if (error) {
 434                 ARPSTAT_INC(txerrors);
 435                 ARP_LOG(LOG_DEBUG, "Failed to send ARP packet on %s: %d\n",
 436                     if_name(ifp), error);
 437         }
 438         return (error);
 439 }
 440
 441 void
 442 arprequest(struct ifnet *ifp, const struct in_addr *sip,
 443     const struct in_addr *tip, u_char *enaddr)
 444 {
 445
 446         (void) arprequest_internal(ifp, sip, tip, enaddr);
 447 }
 448
 449 /*
 450  * Resolve an IP address into an ethernet address - heavy version.
 451  * Used internally by arpresolve().
 452  * We have already checked that we can't use an existing lle without
 453  * modification so we have to acquire an LLE_EXCLUSIVE lle lock.
 454  *
 455  * On success, desten and pflags are filled in and the function returns 0;
 456  * If the packet must be held pending resolution, we return EWOULDBLOCK
 457  * On other errors, we return the corresponding error code.
 458  * Note that m_freem() handles NULL.
 459  */
 460 static int
 461 arpresolve_full(struct ifnet *ifp, int is_gw, int flags, struct mbuf *m,
 462         const struct sockaddr *dst, u_char *desten, uint32_t *pflags,
 463         struct llentry **plle)
 464 {
 465         struct llentry *la = NULL, *la_tmp;
 466         int error, renew;
 467         char *lladdr;
 468         int ll_len;
 469
 470         NET_EPOCH_ASSERT();
 471
 472         if (pflags != NULL)
 473                 *pflags = 0;
 474         if (plle != NULL)
 475                 *plle = NULL;
 476
 477         if ((flags & LLE_CREATE) == 0)
 478                 la = lla_lookup(LLTABLE(ifp), LLE_EXCLUSIVE, dst);
 479         if (la == NULL && (ifp->if_flags & (IFF_NOARP | IFF_STATICARP)) == 0) {
 480                 la = lltable_alloc_entry(LLTABLE(ifp), 0, dst);
 481                 if (la == NULL) {
 482                         char addrbuf[INET_ADDRSTRLEN];
 483
 484                         log(LOG_DEBUG,
 485                             "arpresolve: can't allocate llinfo for %s on %s\n",
 486                             inet_ntoa_r(SIN(dst)->sin_addr, addrbuf),
 487                             if_name(ifp));
 488                         m_freem(m);
 489                         return (EINVAL);
 490                 }
 491
 492                 IF_AFDATA_WLOCK(ifp);
 493                 LLE_WLOCK(la);
 494                 la_tmp = lla_lookup(LLTABLE(ifp), LLE_EXCLUSIVE, dst);
 495                 /* Prefer ANY existing lle over newly-created one */
 496                 if (la_tmp == NULL)
 497                         lltable_link_entry(LLTABLE(ifp), la);
 498                 IF_AFDATA_WUNLOCK(ifp);
 499                 if (la_tmp != NULL) {
 500                         lltable_free_entry(LLTABLE(ifp), la);
 501                         la = la_tmp;
 502                 }
 503         }
 504         if (la == NULL) {
 505                 m_freem(m);
 506                 return (EINVAL);
 507         }
 508
 509         if ((la->la_flags & LLE_VALID) &&
 510             ((la->la_flags & LLE_STATIC) || la->la_expire > time_uptime)) {
 511                 if (flags & LLE_ADDRONLY) {
 512                         lladdr = la->ll_addr;
 513                         ll_len = ifp->if_addrlen;
 514                 } else {
 515                         lladdr = la->r_linkdata;
 516                         ll_len = la->r_hdrlen;
 517                 }
 518                 bcopy(lladdr, desten, ll_len);
 519
 520                 /* Notify LLE code that the entry was used by datapath */
 521                 llentry_provide_feedback(la);
 522                 if (pflags != NULL)
 523                         *pflags = la->la_flags & (LLE_VALID|LLE_IFADDR);
 524                 if (plle) {
 525                         LLE_ADDREF(la);
 526                         *plle = la;
 527                 }
 528                 LLE_WUNLOCK(la);
 529                 return (0);
 530         }
 531
 532         renew = (la->la_asked == 0 || la->la_expire != time_uptime);
 533
 534         /*
 535          * There is an arptab entry, but no ethernet address
 536          * response yet.  Add the mbuf to the list, dropping
 537          * the oldest packet if we have exceeded the system
 538          * setting.
 539          */
 540         if (m != NULL) {
 541                 size_t dropped = lltable_append_entry_queue(la, m, V_arp_maxhold);
 542                 ARPSTAT_ADD(dropped, dropped);
 543         }
 544
 545         /*
 546          * Return EWOULDBLOCK if we have tried less than arp_maxtries. It
 547          * will be masked by ether_output(). Return EHOSTDOWN/EHOSTUNREACH
 548          * if we have already sent arp_maxtries ARP requests. Retransmit the
 549          * ARP request, but not faster than one request per second.
 550          */
 551         if (la->la_asked < V_arp_maxtries)
 552                 error = EWOULDBLOCK;    /* First request. */
 553         else
 554                 error = is_gw != 0 ? EHOSTUNREACH : EHOSTDOWN;
 555
 556         if (renew) {
 557                 int canceled, e;
 558
 559                 LLE_ADDREF(la);
 560                 la->la_expire = time_uptime;
 561                 canceled = callout_reset(&la->lle_timer, hz * V_arpt_down,
 562                     arptimer, la);
 563                 if (canceled)
 564                         LLE_REMREF(la);
 565                 la->la_asked++;
 566                 LLE_WUNLOCK(la);
 567                 e = arprequest_internal(ifp, NULL, &SIN(dst)->sin_addr, NULL);
 568                 /*
 569                  * Only overwrite 'error' in case of error; in case of success
 570                  * the proper return value was already set above.
 571                  */
 572                 if (e != 0)
 573                         return (e);
 574                 return (error);
 575         }
 576
 577         LLE_WUNLOCK(la);
 578         return (error);
 579 }
 580
 581 /*
 582  * Lookups link header based on an IP address.
 583  * On input:
 584  *    ifp is the interface we use
 585  *    is_gw != 0 if @dst represents gateway to some destination
 586  *    m is the mbuf. May be NULL if we don't have a packet.
 587  *    dst is the next hop,
 588  *    desten is the storage to put LL header.
 589  *    flags returns subset of lle flags: LLE_VALID | LLE_IFADDR
 590  *
 591  * On success, full/partial link header and flags are filled in and
 592  * the function returns 0.
 593  * If the packet must be held pending resolution, we return EWOULDBLOCK
 594  * On other errors, we return the corresponding error code.
 595  * Note that m_freem() handles NULL.
 596  */
 597 int
 598 arpresolve(struct ifnet *ifp, int is_gw, struct mbuf *m,
 599         const struct sockaddr *dst, u_char *desten, uint32_t *pflags,
 600         struct llentry **plle)
 601 {
 602         struct llentry *la = NULL;
 603
 604         NET_EPOCH_ASSERT();
 605
 606         if (pflags != NULL)
 607                 *pflags = 0;
 608         if (plle != NULL)
 609                 *plle = NULL;
 610
 611         if (m != NULL) {
 612                 if (m->m_flags & M_BCAST) {
 613                         /* broadcast */
 614                         (void)memcpy(desten,
 615                             ifp->if_broadcastaddr, ifp->if_addrlen);
 616                         return (0);
 617                 }
 618                 if (m->m_flags & M_MCAST) {
 619                         /* multicast */
 620                         ETHER_MAP_IP_MULTICAST(&SIN(dst)->sin_addr, desten);
 621                         return (0);
 622                 }
 623         }
 624
 625         la = lla_lookup(LLTABLE(ifp), plle ? LLE_EXCLUSIVE : LLE_UNLOCKED, dst);
 626         if (la != NULL && (la->r_flags & RLLE_VALID) != 0) {
 627                 /* Entry found, let's copy lle info */
 628                 bcopy(la->r_linkdata, desten, la->r_hdrlen);
 629                 if (pflags != NULL)
 630                         *pflags = LLE_VALID | (la->r_flags & RLLE_IFADDR);
 631                 /* Notify the LLE handling code that the entry was used. */
 632                 llentry_provide_feedback(la);
 633                 if (plle) {
 634                         LLE_ADDREF(la);
 635                         *plle = la;
 636                         LLE_WUNLOCK(la);
 637                 }
 638                 return (0);
 639         }
 640         if (plle && la)
 641                 LLE_WUNLOCK(la);
 642
 643         return (arpresolve_full(ifp, is_gw, la == NULL ? LLE_CREATE : 0, m, dst,
 644             desten, pflags, plle));
 645 }
 646
 647 /*
 648  * Common length and type checks are done here,
 649  * then the protocol-specific routine is called.
 650  */
 651 static void
 652 arpintr(struct mbuf *m)
 653 {
 654         struct arphdr *ar;
 655         struct ifnet *ifp;
 656         char *layer;
 657         int hlen;
 658
 659         ifp = m->m_pkthdr.rcvif;
 660
 661         if (m->m_len < sizeof(struct arphdr) &&
 662             ((m = m_pullup(m, sizeof(struct arphdr))) == NULL)) {
 663                 ARP_LOG(LOG_NOTICE, "packet with short header received on %s\n",
 664                     if_name(ifp));
 665                 return;
 666         }
 667         ar = mtod(m, struct arphdr *);
 668
 669         /* Check if length is sufficient */
 670         if (m->m_len <  arphdr_len(ar)) {
 671                 m = m_pullup(m, arphdr_len(ar));
 672                 if (m == NULL) {
 673                         ARP_LOG(LOG_NOTICE, "short packet received on %s\n",
 674                             if_name(ifp));
 675                         return;
 676                 }
 677                 ar = mtod(m, struct arphdr *);
 678         }
 679
 680         hlen = 0;
 681         layer = "";
 682         switch (ntohs(ar->ar_hrd)) {
 683         case ARPHRD_ETHER:
 684                 hlen = ETHER_ADDR_LEN; /* RFC 826 */
 685                 layer = "ethernet";
 686                 break;
 687         case ARPHRD_INFINIBAND:
 688                 hlen = 20;      /* RFC 4391, INFINIBAND_ALEN */
 689                 layer = "infiniband";
 690                 break;
 691         case ARPHRD_IEEE1394:
 692                 hlen = 0; /* SHALL be 16 */ /* RFC 2734 */
 693                 layer = "firewire";
 694
 695                 /*
 696                  * Restrict too long hardware addresses.
 697                  * Currently we are capable of handling 20-byte
 698                  * addresses ( sizeof(lle->ll_addr) )
 699                  */
 700                 if (ar->ar_hln >= 20)
 701                         hlen = 16;
 702                 break;
 703         default:
 704                 ARP_LOG(LOG_NOTICE,
 705                     "packet with unknown hardware format 0x%02d received on "
 706                     "%s\n", ntohs(ar->ar_hrd), if_name(ifp));
 707                 m_freem(m);
 708                 return;
 709         }
 710
 711         if (hlen != 0 && hlen != ar->ar_hln) {
 712                 ARP_LOG(LOG_NOTICE,
 713                     "packet with invalid %s address length %d received on %s\n",
 714                     layer, ar->ar_hln, if_name(ifp));
 715                 m_freem(m);
 716                 return;
 717         }
 718
 719         ARPSTAT_INC(received);
 720         switch (ntohs(ar->ar_pro)) {
 721 #ifdef INET
 722         case ETHERTYPE_IP:
 723                 in_arpinput(m);
 724                 return;
 725 #endif
 726         }
 727         m_freem(m);
 728 }
 729
 730 #ifdef INET
 731 /*
 732  * ARP for Internet protocols on 10 Mb/s Ethernet.
 733  * Algorithm is that given in RFC 826.
 734  * In addition, a sanity check is performed on the sender
 735  * protocol address, to catch impersonators.
 736  * We no longer handle negotiations for use of trailer protocol:
 737  * Formerly, ARP replied for protocol type ETHERTYPE_TRAIL sent
 738  * along with IP replies if we wanted trailers sent to us,
 739  * and also sent them in response to IP replies.
 740  * This allowed either end to announce the desire to receive
 741  * trailer packets.
 742  * We no longer reply to requests for ETHERTYPE_TRAIL protocol either,
 743  * but formerly didn't normally send requests.
 744  */
 745 static int log_arp_wrong_iface = 1;
 746 static int log_arp_movements = 1;
 747 static int log_arp_permanent_modify = 1;
 748 static int allow_multicast = 0;
 749
 750 SYSCTL_INT(_net_link_ether_inet, OID_AUTO, log_arp_wrong_iface, CTLFLAG_RW,
 751         &log_arp_wrong_iface, 0,
 752         "log arp packets arriving on the wrong interface");
 753 SYSCTL_INT(_net_link_ether_inet, OID_AUTO, log_arp_movements, CTLFLAG_RW,
 754         &log_arp_movements, 0,
 755         "log arp replies from MACs different than the one in the cache");
 756 SYSCTL_INT(_net_link_ether_inet, OID_AUTO, log_arp_permanent_modify, CTLFLAG_RW,
 757         &log_arp_permanent_modify, 0,
 758         "log arp replies from MACs different than the one in the permanent arp entry");
 759 SYSCTL_INT(_net_link_ether_inet, OID_AUTO, allow_multicast, CTLFLAG_RW,
 760         &allow_multicast, 0, "accept multicast addresses");
 761
 762 static void
 763 in_arpinput(struct mbuf *m)
 764 {
 765         struct rm_priotracker in_ifa_tracker;
 766         struct arphdr *ah;
 767         struct ifnet *ifp = m->m_pkthdr.rcvif;
 768         struct llentry *la = NULL, *la_tmp;
 769         struct ifaddr *ifa;
 770         struct in_ifaddr *ia;
 771         struct sockaddr sa;
 772         struct in_addr isaddr, itaddr, myaddr;
 773         u_int8_t *enaddr = NULL;
 774         int op;
 775         int bridged = 0, is_bridge = 0;
 776         int carped;
 777         struct sockaddr_in sin;
 778         struct sockaddr *dst;
 779         struct nhop_object *nh;
 780         uint8_t linkhdr[LLE_MAX_LINKHDR];
 781         struct route ro;
 782         size_t linkhdrsize;
 783         int lladdr_off;
 784         int error;
 785         char addrbuf[INET_ADDRSTRLEN];
 786
 787         NET_EPOCH_ASSERT();
 788
 789         sin.sin_len = sizeof(struct sockaddr_in);
 790         sin.sin_family = AF_INET;
 791         sin.sin_addr.s_addr = 0;
 792
 793         if (ifp->if_bridge)
 794                 bridged = 1;
 795         if (ifp->if_type == IFT_BRIDGE)
 796                 is_bridge = 1;
 797
 798         /*
 799          * We already have checked that mbuf contains enough contiguous data
 800          * to hold entire arp message according to the arp header.
 801          */
 802         ah = mtod(m, struct arphdr *);
 803
 804         /*
 805          * ARP is only for IPv4 so we can reject packets with
 806          * a protocol length not equal to an IPv4 address.
 807          */
 808         if (ah->ar_pln != sizeof(struct in_addr)) {
 809                 ARP_LOG(LOG_NOTICE, "requested protocol length != %zu\n",
 810                     sizeof(struct in_addr));
 811                 goto drop;
 812         }
 813
 814         if (allow_multicast == 0 && ETHER_IS_MULTICAST(ar_sha(ah))) {
 815                 ARP_LOG(LOG_NOTICE, "%*D is multicast\n",
 816                     ifp->if_addrlen, (u_char *)ar_sha(ah), ":");
 817                 goto drop;
 818         }
 819
 820         op = ntohs(ah->ar_op);
 821         (void)memcpy(&isaddr, ar_spa(ah), sizeof (isaddr));
 822         (void)memcpy(&itaddr, ar_tpa(ah), sizeof (itaddr));
 823
 824         if (op == ARPOP_REPLY)
 825                 ARPSTAT_INC(rxreplies);
 826
 827         /*
 828          * For a bridge, we want to check the address irrespective
 829          * of the receive interface. (This will change slightly
 830          * when we have clusters of interfaces).
 831          */
 832         IN_IFADDR_RLOCK(&in_ifa_tracker);
 833         LIST_FOREACH(ia, INADDR_HASH(itaddr.s_addr), ia_hash) {
 834                 if (((bridged && ia->ia_ifp->if_bridge == ifp->if_bridge) ||
 835                     ia->ia_ifp == ifp) &&
 836                     itaddr.s_addr == ia->ia_addr.sin_addr.s_addr &&
 837                     (ia->ia_ifa.ifa_carp == NULL ||
 838                     (*carp_iamatch_p)(&ia->ia_ifa, &enaddr))) {
 839                         ifa_ref(&ia->ia_ifa);
 840                         IN_IFADDR_RUNLOCK(&in_ifa_tracker);
 841                         goto match;
 842                 }
 843         }
 844         LIST_FOREACH(ia, INADDR_HASH(isaddr.s_addr), ia_hash)
 845                 if (((bridged && ia->ia_ifp->if_bridge == ifp->if_bridge) ||
 846                     ia->ia_ifp == ifp) &&
 847                     isaddr.s_addr == ia->ia_addr.sin_addr.s_addr) {
 848                         ifa_ref(&ia->ia_ifa);
 849                         IN_IFADDR_RUNLOCK(&in_ifa_tracker);
 850                         goto match;
 851                 }
 852
 853 #define BDG_MEMBER_MATCHES_ARP(addr, ifp, ia)                           \
 854   (ia->ia_ifp->if_bridge == ifp->if_softc &&                            \
 855   !bcmp(IF_LLADDR(ia->ia_ifp), IF_LLADDR(ifp), ifp->if_addrlen) &&      \
 856   addr == ia->ia_addr.sin_addr.s_addr)
 857         /*
 858          * Check the case when bridge shares its MAC address with
 859          * some of its children, so packets are claimed by bridge
 860          * itself (bridge_input() does it first), but they are really
 861          * meant to be destined to the bridge member.
 862          */
 863         if (is_bridge) {
 864                 LIST_FOREACH(ia, INADDR_HASH(itaddr.s_addr), ia_hash) {
 865                         if (BDG_MEMBER_MATCHES_ARP(itaddr.s_addr, ifp, ia)) {
 866                                 ifa_ref(&ia->ia_ifa);
 867                                 ifp = ia->ia_ifp;
 868                                 IN_IFADDR_RUNLOCK(&in_ifa_tracker);
 869                                 goto match;
 870                         }
 871                 }
 872         }
 873 #undef BDG_MEMBER_MATCHES_ARP
 874         IN_IFADDR_RUNLOCK(&in_ifa_tracker);
 875
 876         /*
 877          * No match, use the first inet address on the receive interface
 878          * as a dummy address for the rest of the function.
 879          */
 880         CK_STAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link)
 881                 if (ifa->ifa_addr->sa_family == AF_INET &&
 882                     (ifa->ifa_carp == NULL ||
 883                     (*carp_iamatch_p)(ifa, &enaddr))) {
 884                         ia = ifatoia(ifa);
 885                         ifa_ref(ifa);
 886                         goto match;
 887                 }
 888
 889         /*
 890          * If bridging, fall back to using any inet address.
 891          */
 892         IN_IFADDR_RLOCK(&in_ifa_tracker);
 893         if (!bridged || (ia = CK_STAILQ_FIRST(&V_in_ifaddrhead)) == NULL) {
 894                 IN_IFADDR_RUNLOCK(&in_ifa_tracker);
 895                 goto drop;
 896         }
 897         ifa_ref(&ia->ia_ifa);
 898         IN_IFADDR_RUNLOCK(&in_ifa_tracker);
 899 match:
 900         if (!enaddr)
 901                 enaddr = (u_int8_t *)IF_LLADDR(ifp);
 902         carped = (ia->ia_ifa.ifa_carp != NULL);
 903         myaddr = ia->ia_addr.sin_addr;
 904         ifa_free(&ia->ia_ifa);
 905         if (!bcmp(ar_sha(ah), enaddr, ifp->if_addrlen))
 906                 goto drop;      /* it's from me, ignore it. */
 907         if (!bcmp(ar_sha(ah), ifp->if_broadcastaddr, ifp->if_addrlen)) {
 908                 ARP_LOG(LOG_NOTICE, "link address is broadcast for IP address "
 909                     "%s!\n", inet_ntoa_r(isaddr, addrbuf));
 910                 goto drop;
 911         }
 912
 913         if (ifp->if_addrlen != ah->ar_hln) {
 914                 ARP_LOG(LOG_WARNING, "from %*D: addr len: new %d, "
 915                     "i/f %d (ignored)\n", ifp->if_addrlen,
 916                     (u_char *) ar_sha(ah), ":", ah->ar_hln,
 917                     ifp->if_addrlen);
 918                 goto drop;
 919         }
 920
 921         /*
 922          * Warn if another host is using the same IP address, but only if the
 923          * IP address isn't 0.0.0.0, which is used for DHCP only, in which
 924          * case we suppress the warning to avoid false positive complaints of
 925          * potential misconfiguration.
 926          */
 927         if (!bridged && !carped && isaddr.s_addr == myaddr.s_addr &&
 928             myaddr.s_addr != 0) {
 929                 ARP_LOG(LOG_ERR, "%*D is using my IP address %s on %s!\n",
 930                    ifp->if_addrlen, (u_char *)ar_sha(ah), ":",
 931                    inet_ntoa_r(isaddr, addrbuf), ifp->if_xname);
 932                 itaddr = myaddr;
 933                 ARPSTAT_INC(dupips);
 934                 goto reply;
 935         }
 936         if (ifp->if_flags & IFF_STATICARP)
 937                 goto reply;
 938
 939         bzero(&sin, sizeof(sin));
 940         sin.sin_len = sizeof(struct sockaddr_in);
 941         sin.sin_family = AF_INET;
 942         sin.sin_addr = isaddr;
 943         dst = (struct sockaddr *)&sin;
 944         la = lla_lookup(LLTABLE(ifp), LLE_EXCLUSIVE, dst);
 945         if (la != NULL)
 946                 arp_check_update_lle(ah, isaddr, ifp, bridged, la);
 947         else if (itaddr.s_addr == myaddr.s_addr) {
 948                 /*
 949                  * Request/reply to our address, but no lle exists yet.
 950                  * Calculate full link prepend to use in lle.
 951                  */
 952                 linkhdrsize = sizeof(linkhdr);
 953                 if (lltable_calc_llheader(ifp, AF_INET, ar_sha(ah), linkhdr,
 954                     &linkhdrsize, &lladdr_off) != 0)
 955                         goto reply;
 956
 957                 /* Allocate new entry */
 958                 la = lltable_alloc_entry(LLTABLE(ifp), 0, dst);
 959                 if (la == NULL) {
 960                         /*
 961                          * lle creation may fail if source address belongs
 962                          * to non-directly connected subnet. However, we
 963                          * will try to answer the request instead of dropping
 964                          * frame.
 965                          */
 966                         goto reply;
 967                 }
 968                 lltable_set_entry_addr(ifp, la, linkhdr, linkhdrsize,
 969                     lladdr_off);
 970
 971                 IF_AFDATA_WLOCK(ifp);
 972                 LLE_WLOCK(la);
 973                 la_tmp = lla_lookup(LLTABLE(ifp), LLE_EXCLUSIVE, dst);
 974
 975                 /*
 976                  * Check if lle still does not exists.
 977                  * If it does, that means that we either
 978                  * 1) have configured it explicitly, via
 979                  * 1a) 'arp -s' static entry or
 980                  * 1b) interface address static record
 981                  * or
 982                  * 2) it was the result of sending first packet to-host
 983                  * or
 984                  * 3) it was another arp reply packet we handled in
 985                  * different thread.
 986                  *
 987                  * In all cases except 3) we definitely need to prefer
 988                  * existing lle. For the sake of simplicity, prefer any
 989                  * existing lle over newly-create one.
 990                  */
 991                 if (la_tmp == NULL)
 992                         lltable_link_entry(LLTABLE(ifp), la);
 993                 IF_AFDATA_WUNLOCK(ifp);
 994
 995                 if (la_tmp == NULL) {
 996                         arp_mark_lle_reachable(la);
 997                         LLE_WUNLOCK(la);
 998                 } else {
 999                         /* Free newly-create entry and handle packet */
1000                         lltable_free_entry(LLTABLE(ifp), la);
1001                         la = la_tmp;
1002                         la_tmp = NULL;
1003                         arp_check_update_lle(ah, isaddr, ifp, bridged, la);
1004                         /* arp_check_update_lle() returns @la unlocked */
1005                 }
1006                 la = NULL;
1007         }
1008 reply:
1009         if (op != ARPOP_REQUEST)
1010                 goto drop;
1011         ARPSTAT_INC(rxrequests);
1012
1013         if (itaddr.s_addr == myaddr.s_addr) {
1014                 /* Shortcut.. the receiving interface is the target. */
1015                 (void)memcpy(ar_tha(ah), ar_sha(ah), ah->ar_hln);
1016                 (void)memcpy(ar_sha(ah), enaddr, ah->ar_hln);
1017         } else {
1018                 /*
1019                  * Destination address is not ours. Check if
1020                  * proxyarp entry exists or proxyarp is turned on globally.
1021                  */
1022                 struct llentry *lle;
1023
1024                 sin.sin_addr = itaddr;
1025                 lle = lla_lookup(LLTABLE(ifp), 0, (struct sockaddr *)&sin);
1026
1027                 if ((lle != NULL) && (lle->la_flags & LLE_PUB)) {
1028                         (void)memcpy(ar_tha(ah), ar_sha(ah), ah->ar_hln);
1029                         (void)memcpy(ar_sha(ah), lle->ll_addr, ah->ar_hln);
1030                         LLE_RUNLOCK(lle);
1031                 } else {
1032                         if (lle != NULL)
1033                                 LLE_RUNLOCK(lle);
1034
1035                         if (!V_arp_proxyall)
1036                                 goto drop;
1037
1038                         NET_EPOCH_ASSERT();
1039                         nh = fib4_lookup(ifp->if_fib, itaddr, 0, 0, 0);
1040                         if (nh == NULL)
1041                                 goto drop;
1042
1043                         /*
1044                          * Don't send proxies for nodes on the same interface
1045                          * as this one came out of, or we'll get into a fight
1046                          * over who claims what Ether address.
1047                          */
1048                         if (nh->nh_ifp == ifp)
1049                                 goto drop;
1050
1051                         (void)memcpy(ar_tha(ah), ar_sha(ah), ah->ar_hln);
1052                         (void)memcpy(ar_sha(ah), enaddr, ah->ar_hln);
1053
1054                         /*
1055                          * Also check that the node which sent the ARP packet
1056                          * is on the interface we expect it to be on. This
1057                          * avoids ARP chaos if an interface is connected to the
1058                          * wrong network.
1059                          */
1060
1061                         nh = fib4_lookup(ifp->if_fib, isaddr, 0, 0, 0);
1062                         if (nh == NULL)
1063                                 goto drop;
1064                         if (nh->nh_ifp != ifp) {
1065                                 ARP_LOG(LOG_INFO, "proxy: ignoring request"
1066                                     " from %s via %s\n",
1067                                     inet_ntoa_r(isaddr, addrbuf),
1068                                     ifp->if_xname);
1069                                 goto drop;
1070                         }
1071
1072 #ifdef DEBUG_PROXY
1073                         printf("arp: proxying for %s\n",
1074                             inet_ntoa_r(itaddr, addrbuf));
1075 #endif
1076                 }
1077         }
1078
1079         if (itaddr.s_addr == myaddr.s_addr &&
1080             IN_LINKLOCAL(ntohl(itaddr.s_addr))) {
1081                 /* RFC 3927 link-local IPv4; always reply by broadcast. */
1082 #ifdef DEBUG_LINKLOCAL
1083                 printf("arp: sending reply for link-local addr %s\n",
1084                     inet_ntoa_r(itaddr, addrbuf));
1085 #endif
1086                 m->m_flags |= M_BCAST;
1087                 m->m_flags &= ~M_MCAST;
1088         } else {
1089                 /* default behaviour; never reply by broadcast. */
1090                 m->m_flags &= ~(M_BCAST|M_MCAST);
1091         }
1092         (void)memcpy(ar_tpa(ah), ar_spa(ah), ah->ar_pln);
1093         (void)memcpy(ar_spa(ah), &itaddr, ah->ar_pln);
1094         ah->ar_op = htons(ARPOP_REPLY);
1095         ah->ar_pro = htons(ETHERTYPE_IP); /* let's be sure! */
1096         m->m_len = sizeof(*ah) + (2 * ah->ar_pln) + (2 * ah->ar_hln);
1097         m->m_pkthdr.len = m->m_len;
1098         m->m_pkthdr.rcvif = NULL;
1099         sa.sa_family = AF_ARP;
1100         sa.sa_len = 2;
1101
1102         /* Calculate link header for sending frame */
1103         bzero(&ro, sizeof(ro));
1104         linkhdrsize = sizeof(linkhdr);
1105         error = arp_fillheader(ifp, ah, 0, linkhdr, &linkhdrsize);
1106
1107         /*
1108          * arp_fillheader() may fail due to lack of support inside encap request
1109          * routing. This is not necessary an error, AF_ARP can/should be handled
1110          * by if_output().
1111          */
1112         if (error != 0 && error != EAFNOSUPPORT) {
1113                 ARP_LOG(LOG_ERR, "Failed to calculate ARP header on %s: %d\n",
1114                     if_name(ifp), error);
1115                 goto drop;
1116         }
1117
1118         ro.ro_prepend = linkhdr;
1119         ro.ro_plen = linkhdrsize;
1120         ro.ro_flags = 0;
1121
1122         m_clrprotoflags(m);     /* Avoid confusing lower layers. */
1123         (*ifp->if_output)(ifp, m, &sa, &ro);
1124         ARPSTAT_INC(txreplies);
1125         return;
1126
1127 drop:
1128         m_freem(m);
1129 }
1130 #endif
1131
1132 static struct mbuf *
1133 arp_grab_holdchain(struct llentry *la)
1134 {
1135         struct mbuf *chain;
1136
1137         LLE_WLOCK_ASSERT(la);
1138
1139         chain = la->la_hold;
1140         la->la_hold = NULL;
1141         la->la_numheld = 0;
1142
1143         return (chain);
1144 }
1145
1146 static void
1147 arp_flush_holdchain(struct ifnet *ifp, struct llentry *la, struct mbuf *chain)
1148 {
1149         struct mbuf *m_hold, *m_hold_next;
1150         struct sockaddr_in sin;
1151
1152         NET_EPOCH_ASSERT();
1153
1154         struct route ro = {
1155                 .ro_prepend = la->r_linkdata,
1156                 .ro_plen = la->r_hdrlen,
1157         };
1158
1159         lltable_fill_sa_entry(la, (struct sockaddr *)&sin);
1160
1161         for (m_hold = chain; m_hold != NULL; m_hold = m_hold_next) {
1162                 m_hold_next = m_hold->m_nextpkt;
1163                 m_hold->m_nextpkt = NULL;
1164                 /* Avoid confusing lower layers. */
1165                 m_clrprotoflags(m_hold);
1166                 (*ifp->if_output)(ifp, m_hold, (struct sockaddr *)&sin, &ro);
1167         }
1168 }
1169
1170 /*
1171  * Checks received arp data against existing @la.
1172  * Updates lle state/performs notification if necessary.
1173  */
1174 static void
1175 arp_check_update_lle(struct arphdr *ah, struct in_addr isaddr, struct ifnet *ifp,
1176     int bridged, struct llentry *la)
1177 {
1178         uint8_t linkhdr[LLE_MAX_LINKHDR];
1179         size_t linkhdrsize;
1180         int lladdr_off;
1181         char addrbuf[INET_ADDRSTRLEN];
1182
1183         LLE_WLOCK_ASSERT(la);
1184
1185         /* the following is not an error when doing bridging */
1186         if (!bridged && la->lle_tbl->llt_ifp != ifp) {
1187                 if (log_arp_wrong_iface)
1188                         ARP_LOG(LOG_WARNING, "%s is on %s "
1189                             "but got reply from %*D on %s\n",
1190                             inet_ntoa_r(isaddr, addrbuf),
1191                             la->lle_tbl->llt_ifp->if_xname,
1192                             ifp->if_addrlen, (u_char *)ar_sha(ah), ":",
1193                             ifp->if_xname);
1194                 LLE_WUNLOCK(la);
1195                 return;
1196         }
1197         if ((la->la_flags & LLE_VALID) &&
1198             bcmp(ar_sha(ah), la->ll_addr, ifp->if_addrlen)) {
1199                 if (la->la_flags & LLE_STATIC) {
1200                         LLE_WUNLOCK(la);
1201                         if (log_arp_permanent_modify)
1202                                 ARP_LOG(LOG_ERR,
1203                                     "%*D attempts to modify "
1204                                     "permanent entry for %s on %s\n",
1205                                     ifp->if_addrlen,
1206                                     (u_char *)ar_sha(ah), ":",
1207                                     inet_ntoa_r(isaddr, addrbuf),
1208                                     ifp->if_xname);
1209                         return;
1210                 }
1211                 if (log_arp_movements) {
1212                         ARP_LOG(LOG_INFO, "%s moved from %*D "
1213                             "to %*D on %s\n",
1214                             inet_ntoa_r(isaddr, addrbuf),
1215                             ifp->if_addrlen,
1216                             (u_char *)la->ll_addr, ":",
1217                             ifp->if_addrlen, (u_char *)ar_sha(ah), ":",
1218                             ifp->if_xname);
1219                 }
1220         }
1221
1222         /* Calculate full link prepend to use in lle */
1223         linkhdrsize = sizeof(linkhdr);
1224         if (lltable_calc_llheader(ifp, AF_INET, ar_sha(ah), linkhdr,
1225             &linkhdrsize, &lladdr_off) != 0) {
1226                 LLE_WUNLOCK(la);
1227                 return;
1228         }
1229
1230         /* Check if something has changed */
1231         if (memcmp(la->r_linkdata, linkhdr, linkhdrsize) != 0 ||
1232             (la->la_flags & LLE_VALID) == 0) {
1233                 /* Try to perform LLE update */
1234                 if (lltable_try_set_entry_addr(ifp, la, linkhdr, linkhdrsize,
1235                     lladdr_off) == 0) {
1236                         LLE_WUNLOCK(la);
1237                         return;
1238                 }
1239
1240                 /* Clear fast path feedback request if set */
1241                 llentry_mark_used(la);
1242         }
1243
1244         arp_mark_lle_reachable(la);
1245
1246         /*
1247          * The packets are all freed within the call to the output
1248          * routine.
1249          *
1250          * NB: The lock MUST be released before the call to the
1251          * output routine.
1252          */
1253         if (la->la_hold != NULL) {
1254                 struct mbuf *chain;
1255
1256                 chain = arp_grab_holdchain(la);
1257                 LLE_WUNLOCK(la);
1258                 arp_flush_holdchain(ifp, la, chain);
1259         } else
1260                 LLE_WUNLOCK(la);
1261 }
1262
1263 static void
1264 arp_mark_lle_reachable(struct llentry *la)
1265 {
1266         int canceled, wtime;
1267
1268         LLE_WLOCK_ASSERT(la);
1269
1270         la->ln_state = ARP_LLINFO_REACHABLE;
1271         EVENTHANDLER_INVOKE(lle_event, la, LLENTRY_RESOLVED);
1272
1273         if (!(la->la_flags & LLE_STATIC)) {
1274                 LLE_ADDREF(la);
1275                 la->la_expire = time_uptime + V_arpt_keep;
1276                 wtime = V_arpt_keep - V_arp_maxtries * V_arpt_rexmit;
1277                 if (wtime < 0)
1278                         wtime = V_arpt_keep;
1279                 canceled = callout_reset(&la->lle_timer,
1280                     hz * wtime, arptimer, la);
1281                 if (canceled)
1282                         LLE_REMREF(la);
1283         }
1284         la->la_asked = 0;
1285         la->la_preempt = V_arp_maxtries;
1286 }
1287
1288 /*
1289  * Add permanent link-layer record for given interface address.
1290  */
1291 static __noinline void
1292 arp_add_ifa_lle(struct ifnet *ifp, const struct sockaddr *dst)
1293 {
1294         struct llentry *lle, *lle_tmp;
1295
1296         /*
1297          * Interface address LLE record is considered static
1298          * because kernel code relies on LLE_STATIC flag to check
1299          * if these entries can be rewriten by arp updates.
1300          */
1301         lle = lltable_alloc_entry(LLTABLE(ifp), LLE_IFADDR | LLE_STATIC, dst);
1302         if (lle == NULL) {
1303                 log(LOG_INFO, "arp_ifinit: cannot create arp "
1304                     "entry for interface address\n");
1305                 return;
1306         }
1307
1308         IF_AFDATA_WLOCK(ifp);
1309         LLE_WLOCK(lle);
1310         /* Unlink any entry if exists */
1311         lle_tmp = lla_lookup(LLTABLE(ifp), LLE_EXCLUSIVE, dst);
1312         if (lle_tmp != NULL)
1313                 lltable_unlink_entry(LLTABLE(ifp), lle_tmp);
1314
1315         lltable_link_entry(LLTABLE(ifp), lle);
1316         IF_AFDATA_WUNLOCK(ifp);
1317
1318         if (lle_tmp != NULL)
1319                 EVENTHANDLER_INVOKE(lle_event, lle_tmp, LLENTRY_EXPIRED);
1320
1321         EVENTHANDLER_INVOKE(lle_event, lle, LLENTRY_RESOLVED);
1322         LLE_WUNLOCK(lle);
1323         if (lle_tmp != NULL)
1324                 lltable_free_entry(LLTABLE(ifp), lle_tmp);
1325 }
1326
1327 /*
1328  * Handle the garp_rexmit_count. Like sysctl_handle_int(), but limits the range
1329  * of valid values.
1330  */
1331 static int
1332 sysctl_garp_rexmit(SYSCTL_HANDLER_ARGS)
1333 {
1334         int error;
1335         int rexmit_count = *(int *)arg1;
1336
1337         error = sysctl_handle_int(oidp, &rexmit_count, 0, req);
1338
1339         /* Enforce limits on any new value that may have been set. */
1340         if (!error && req->newptr) {
1341                 /* A new value was set. */
1342                 if (rexmit_count < 0) {
1343                         rexmit_count = 0;
1344                 } else if (rexmit_count > MAX_GARP_RETRANSMITS) {
1345                         rexmit_count = MAX_GARP_RETRANSMITS;
1346                 }
1347                 *(int *)arg1 = rexmit_count;
1348         }
1349
1350         return (error);
1351 }
1352
1353 /*
1354  * Retransmit a Gratuitous ARP (GARP) and, if necessary, schedule a callout to
1355  * retransmit it again. A pending callout owns a reference to the ifa.
1356  */
1357 static void
1358 garp_rexmit(void *arg)
1359 {
1360         struct in_ifaddr *ia = arg;
1361
1362         if (callout_pending(&ia->ia_garp_timer) ||
1363             !callout_active(&ia->ia_garp_timer)) {
1364                 IF_ADDR_WUNLOCK(ia->ia_ifa.ifa_ifp);
1365                 ifa_free(&ia->ia_ifa);
1366                 return;
1367         }
1368
1369         CURVNET_SET(ia->ia_ifa.ifa_ifp->if_vnet);
1370
1371         /*
1372          * Drop lock while the ARP request is generated.
1373          */
1374         IF_ADDR_WUNLOCK(ia->ia_ifa.ifa_ifp);
1375
1376         arprequest(ia->ia_ifa.ifa_ifp, &IA_SIN(ia)->sin_addr,
1377             &IA_SIN(ia)->sin_addr, IF_LLADDR(ia->ia_ifa.ifa_ifp));
1378
1379         /*
1380          * Increment the count of retransmissions. If the count has reached the
1381          * maximum value, stop sending the GARP packets. Otherwise, schedule
1382          * the callout to retransmit another GARP packet.
1383          */
1384         ++ia->ia_garp_count;
1385         if (ia->ia_garp_count >= garp_rexmit_count) {
1386                 ifa_free(&ia->ia_ifa);
1387         } else {
1388                 int rescheduled;
1389                 IF_ADDR_WLOCK(ia->ia_ifa.ifa_ifp);
1390                 rescheduled = callout_reset(&ia->ia_garp_timer,
1391                     (1 << ia->ia_garp_count) * hz,
1392                     garp_rexmit, ia);
1393                 IF_ADDR_WUNLOCK(ia->ia_ifa.ifa_ifp);
1394                 if (rescheduled) {
1395                         ifa_free(&ia->ia_ifa);
1396                 }
1397         }
1398
1399         CURVNET_RESTORE();
1400 }
1401
1402 /*
1403  * Start the GARP retransmit timer.
1404  *
1405  * A single GARP is always transmitted when an IPv4 address is added
1406  * to an interface and that is usually sufficient. However, in some
1407  * circumstances, such as when a shared address is passed between
1408  * cluster nodes, this single GARP may occasionally be dropped or
1409  * lost. This can lead to neighbors on the network link working with a
1410  * stale ARP cache and sending packets destined for that address to
1411  * the node that previously owned the address, which may not respond.
1412  *
1413  * To avoid this situation, GARP retransmits can be enabled by setting
1414  * the net.link.ether.inet.garp_rexmit_count sysctl to a value greater
1415  * than zero. The setting represents the maximum number of
1416  * retransmissions. The interval between retransmissions is calculated
1417  * using an exponential backoff algorithm, doubling each time, so the
1418  * retransmission intervals are: {1, 2, 4, 8, 16, ...} (seconds).
1419  */
1420 static void
1421 garp_timer_start(struct ifaddr *ifa)
1422 {
1423         struct in_ifaddr *ia = (struct in_ifaddr *) ifa;
1424
1425         IF_ADDR_WLOCK(ia->ia_ifa.ifa_ifp);
1426         ia->ia_garp_count = 0;
1427         if (callout_reset(&ia->ia_garp_timer, (1 << ia->ia_garp_count) * hz,
1428             garp_rexmit, ia) == 0) {
1429                 ifa_ref(ifa);
1430         }
1431         IF_ADDR_WUNLOCK(ia->ia_ifa.ifa_ifp);
1432 }
1433
1434 void
1435 arp_ifinit(struct ifnet *ifp, struct ifaddr *ifa)
1436 {
1437         struct epoch_tracker et;
1438         const struct sockaddr_in *dst_in;
1439         const struct sockaddr *dst;
1440
1441         if (ifa->ifa_carp != NULL)
1442                 return;
1443
1444         dst = ifa->ifa_addr;
1445         dst_in = (const struct sockaddr_in *)dst;
1446
1447         if (ntohl(dst_in->sin_addr.s_addr) == INADDR_ANY)
1448                 return;
1449         NET_EPOCH_ENTER(et);
1450         arp_announce_ifaddr(ifp, dst_in->sin_addr, IF_LLADDR(ifp));
1451         NET_EPOCH_EXIT(et);
1452         if (garp_rexmit_count > 0) {
1453                 garp_timer_start(ifa);
1454         }
1455
1456         arp_add_ifa_lle(ifp, dst);
1457 }
1458
1459 void
1460 arp_announce_ifaddr(struct ifnet *ifp, struct in_addr addr, u_char *enaddr)
1461 {
1462
1463         if (ntohl(addr.s_addr) != INADDR_ANY)
1464                 arprequest(ifp, &addr, &addr, enaddr);
1465 }
1466
1467 /*
1468  * Sends gratuitous ARPs for each ifaddr to notify other
1469  * nodes about the address change.
1470  */
1471 static __noinline void
1472 arp_handle_ifllchange(struct ifnet *ifp)
1473 {
1474         struct ifaddr *ifa;
1475
1476         CK_STAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) {
1477                 if (ifa->ifa_addr->sa_family == AF_INET)
1478                         arp_ifinit(ifp, ifa);
1479         }
1480 }
1481
1482 /*
1483  * A handler for interface link layer address change event.
1484  */
1485 static void
1486 arp_iflladdr(void *arg __unused, struct ifnet *ifp)
1487 {
1488         /* if_bridge can update its lladdr during if_vmove(), after we've done
1489          * if_detach_internal()/dom_ifdetach(). */
1490         if (ifp->if_afdata[AF_INET] == NULL)
1491                 return;
1492
1493         lltable_update_ifaddr(LLTABLE(ifp));
1494
1495         if ((ifp->if_flags & IFF_UP) != 0)
1496                 arp_handle_ifllchange(ifp);
1497 }
1498
1499 static void
1500 vnet_arp_init(void)
1501 {
1502
1503         if (IS_DEFAULT_VNET(curvnet)) {
1504                 netisr_register(&arp_nh);
1505                 iflladdr_tag = EVENTHANDLER_REGISTER(iflladdr_event,
1506                     arp_iflladdr, NULL, EVENTHANDLER_PRI_ANY);
1507         }
1508 #ifdef VIMAGE
1509         else
1510                 netisr_register_vnet(&arp_nh);
1511 #endif
1512 }
1513 VNET_SYSINIT(vnet_arp_init, SI_SUB_PROTO_DOMAIN, SI_ORDER_SECOND,
1514     vnet_arp_init, 0);
1515
1516 #ifdef VIMAGE
1517 /*
1518  * We have to unregister ARP along with IP otherwise we risk doing INADDR_HASH
1519  * lookups after destroying the hash.  Ideally this would go on SI_ORDER_3.5.
1520  */
1521 static void
1522 vnet_arp_destroy(__unused void *arg)
1523 {
1524
1525         netisr_unregister_vnet(&arp_nh);
1526 }
1527 VNET_SYSUNINIT(vnet_arp_uninit, SI_SUB_PROTO_DOMAIN, SI_ORDER_THIRD,
1528     vnet_arp_destroy, NULL);
1529 #endif