sys/net/if_ethersubr.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1989, 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_ethersubr.c      8.1 (Berkeley) 6/10/93
  32  * $FreeBSD$
  33  */
  34
  35 #include "opt_inet.h"
  36 #include "opt_inet6.h"
  37 #include "opt_netgraph.h"
  38 #include "opt_mbuf_profiling.h"
  39 #include "opt_rss.h"
  40
  41 #include <sys/param.h>
  42 #include <sys/systm.h>
  43 #include <sys/bus.h>
  44 #include <sys/eventhandler.h>
  45 #include <sys/jail.h>
  46 #include <sys/kernel.h>
  47 #include <sys/lock.h>
  48 #include <sys/malloc.h>
  49 #include <sys/module.h>
  50 #include <sys/mbuf.h>
  51 #include <sys/proc.h>
  52 #include <sys/priv.h>
  53 #include <sys/random.h>
  54 #include <sys/socket.h>
  55 #include <sys/sockio.h>
  56 #include <sys/sysctl.h>
  57 #include <sys/uuid.h>
  58
  59 #include <net/ieee_oui.h>
  60 #include <net/if.h>
  61 #include <net/if_var.h>
  62 #include <net/if_arp.h>
  63 #include <net/netisr.h>
  64 #include <net/route.h>
  65 #include <net/if_llc.h>
  66 #include <net/if_dl.h>
  67 #include <net/if_types.h>
  68 #include <net/bpf.h>
  69 #include <net/ethernet.h>
  70 #include <net/if_bridgevar.h>
  71 #include <net/if_vlan_var.h>
  72 #include <net/if_llatbl.h>
  73 #include <net/pfil.h>
  74 #include <net/rss_config.h>
  75 #include <net/vnet.h>
  76
  77 #include <netpfil/pf/pf_mtag.h>
  78
  79 #if defined(INET) || defined(INET6)
  80 #include <netinet/in.h>
  81 #include <netinet/in_var.h>
  82 #include <netinet/if_ether.h>
  83 #include <netinet/ip_carp.h>
  84 #include <netinet/ip_var.h>
  85 #endif
  86 #ifdef INET6
  87 #include <netinet6/nd6.h>
  88 #endif
  89 #include <security/mac/mac_framework.h>
  90
  91 #include <crypto/sha1.h>
  92
  93 #ifdef CTASSERT
  94 CTASSERT(sizeof (struct ether_header) == ETHER_ADDR_LEN * 2 + 2);
  95 CTASSERT(sizeof (struct ether_addr) == ETHER_ADDR_LEN);
  96 #endif
  97
  98 VNET_DEFINE(struct pfil_head, link_pfil_hook);  /* Packet filter hooks */
  99
 100 /* netgraph node hooks for ng_ether(4) */
 101 void    (*ng_ether_input_p)(struct ifnet *ifp, struct mbuf **mp);
 102 void    (*ng_ether_input_orphan_p)(struct ifnet *ifp, struct mbuf *m);
 103 int     (*ng_ether_output_p)(struct ifnet *ifp, struct mbuf **mp);
 104 void    (*ng_ether_attach_p)(struct ifnet *ifp);
 105 void    (*ng_ether_detach_p)(struct ifnet *ifp);
 106
 107 void    (*vlan_input_p)(struct ifnet *, struct mbuf *);
 108
 109 /* if_bridge(4) support */
 110 void    (*bridge_dn_p)(struct mbuf *, struct ifnet *);
 111
 112 /* if_lagg(4) support */
 113 struct mbuf *(*lagg_input_p)(struct ifnet *, struct mbuf *);
 114
 115 static const u_char etherbroadcastaddr[ETHER_ADDR_LEN] =
 116                         { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
 117
 118 static  int ether_resolvemulti(struct ifnet *, struct sockaddr **,
 119                 struct sockaddr *);
 120 #ifdef VIMAGE
 121 static  void ether_reassign(struct ifnet *, struct vnet *, char *);
 122 #endif
 123 static  int ether_requestencap(struct ifnet *, struct if_encap_req *);
 124
 125
 126 #define senderr(e) do { error = (e); goto bad;} while (0)
 127
 128 static void
 129 update_mbuf_csumflags(struct mbuf *src, struct mbuf *dst)
 130 {
 131         int csum_flags = 0;
 132
 133         if (src->m_pkthdr.csum_flags & CSUM_IP)
 134                 csum_flags |= (CSUM_IP_CHECKED|CSUM_IP_VALID);
 135         if (src->m_pkthdr.csum_flags & CSUM_DELAY_DATA)
 136                 csum_flags |= (CSUM_DATA_VALID|CSUM_PSEUDO_HDR);
 137         if (src->m_pkthdr.csum_flags & CSUM_SCTP)
 138                 csum_flags |= CSUM_SCTP_VALID;
 139         dst->m_pkthdr.csum_flags |= csum_flags;
 140         if (csum_flags & CSUM_DATA_VALID)
 141                 dst->m_pkthdr.csum_data = 0xffff;
 142 }
 143
 144 /*
 145  * Handle link-layer encapsulation requests.
 146  */
 147 static int
 148 ether_requestencap(struct ifnet *ifp, struct if_encap_req *req)
 149 {
 150         struct ether_header *eh;
 151         struct arphdr *ah;
 152         uint16_t etype;
 153         const u_char *lladdr;
 154
 155         if (req->rtype != IFENCAP_LL)
 156                 return (EOPNOTSUPP);
 157
 158         if (req->bufsize < ETHER_HDR_LEN)
 159                 return (ENOMEM);
 160
 161         eh = (struct ether_header *)req->buf;
 162         lladdr = req->lladdr;
 163         req->lladdr_off = 0;
 164
 165         switch (req->family) {
 166         case AF_INET:
 167                 etype = htons(ETHERTYPE_IP);
 168                 break;
 169         case AF_INET6:
 170                 etype = htons(ETHERTYPE_IPV6);
 171                 break;
 172         case AF_ARP:
 173                 ah = (struct arphdr *)req->hdata;
 174                 ah->ar_hrd = htons(ARPHRD_ETHER);
 175
 176                 switch(ntohs(ah->ar_op)) {
 177                 case ARPOP_REVREQUEST:
 178                 case ARPOP_REVREPLY:
 179                         etype = htons(ETHERTYPE_REVARP);
 180                         break;
 181                 case ARPOP_REQUEST:
 182                 case ARPOP_REPLY:
 183                 default:
 184                         etype = htons(ETHERTYPE_ARP);
 185                         break;
 186                 }
 187
 188                 if (req->flags & IFENCAP_FLAG_BROADCAST)
 189                         lladdr = ifp->if_broadcastaddr;
 190                 break;
 191         default:
 192                 return (EAFNOSUPPORT);
 193         }
 194
 195         memcpy(&eh->ether_type, &etype, sizeof(eh->ether_type));
 196         memcpy(eh->ether_dhost, lladdr, ETHER_ADDR_LEN);
 197         memcpy(eh->ether_shost, IF_LLADDR(ifp), ETHER_ADDR_LEN);
 198         req->bufsize = sizeof(struct ether_header);
 199
 200         return (0);
 201 }
 202
 203
 204 static int
 205 ether_resolve_addr(struct ifnet *ifp, struct mbuf *m,
 206         const struct sockaddr *dst, struct route *ro, u_char *phdr,
 207         uint32_t *pflags, struct llentry **plle)
 208 {
 209         struct ether_header *eh;
 210         uint32_t lleflags = 0;
 211         int error = 0;
 212 #if defined(INET) || defined(INET6)
 213         uint16_t etype;
 214 #endif
 215
 216         if (plle)
 217                 *plle = NULL;
 218         eh = (struct ether_header *)phdr;
 219
 220         switch (dst->sa_family) {
 221 #ifdef INET
 222         case AF_INET:
 223                 if ((m->m_flags & (M_BCAST | M_MCAST)) == 0)
 224                         error = arpresolve(ifp, 0, m, dst, phdr, &lleflags,
 225                             plle);
 226                 else {
 227                         if (m->m_flags & M_BCAST)
 228                                 memcpy(eh->ether_dhost, ifp->if_broadcastaddr,
 229                                     ETHER_ADDR_LEN);
 230                         else {
 231                                 const struct in_addr *a;
 232                                 a = &(((const struct sockaddr_in *)dst)->sin_addr);
 233                                 ETHER_MAP_IP_MULTICAST(a, eh->ether_dhost);
 234                         }
 235                         etype = htons(ETHERTYPE_IP);
 236                         memcpy(&eh->ether_type, &etype, sizeof(etype));
 237                         memcpy(eh->ether_shost, IF_LLADDR(ifp), ETHER_ADDR_LEN);
 238                 }
 239                 break;
 240 #endif
 241 #ifdef INET6
 242         case AF_INET6:
 243                 if ((m->m_flags & M_MCAST) == 0)
 244                         error = nd6_resolve(ifp, 0, m, dst, phdr, &lleflags,
 245                             plle);
 246                 else {
 247                         const struct in6_addr *a6;
 248                         a6 = &(((const struct sockaddr_in6 *)dst)->sin6_addr);
 249                         ETHER_MAP_IPV6_MULTICAST(a6, eh->ether_dhost);
 250                         etype = htons(ETHERTYPE_IPV6);
 251                         memcpy(&eh->ether_type, &etype, sizeof(etype));
 252                         memcpy(eh->ether_shost, IF_LLADDR(ifp), ETHER_ADDR_LEN);
 253                 }
 254                 break;
 255 #endif
 256         default:
 257                 if_printf(ifp, "can't handle af%d\n", dst->sa_family);
 258                 if (m != NULL)
 259                         m_freem(m);
 260                 return (EAFNOSUPPORT);
 261         }
 262
 263         if (error == EHOSTDOWN) {
 264                 if (ro != NULL && (ro->ro_flags & RT_HAS_GW) != 0)
 265                         error = EHOSTUNREACH;
 266         }
 267
 268         if (error != 0)
 269                 return (error);
 270
 271         *pflags = RT_MAY_LOOP;
 272         if (lleflags & LLE_IFADDR)
 273                 *pflags |= RT_L2_ME;
 274
 275         return (0);
 276 }
 277
 278 /*
 279  * Ethernet output routine.
 280  * Encapsulate a packet of type family for the local net.
 281  * Use trailer local net encapsulation if enough data in first
 282  * packet leaves a multiple of 512 bytes of data in remainder.
 283  */
 284 int
 285 ether_output(struct ifnet *ifp, struct mbuf *m,
 286         const struct sockaddr *dst, struct route *ro)
 287 {
 288         int error = 0;
 289         char linkhdr[ETHER_HDR_LEN], *phdr;
 290         struct ether_header *eh;
 291         struct pf_mtag *t;
 292         int loop_copy = 1;
 293         int hlen;       /* link layer header length */
 294         uint32_t pflags;
 295         struct llentry *lle = NULL;
 296         int addref = 0;
 297
 298         phdr = NULL;
 299         pflags = 0;
 300         if (ro != NULL) {
 301                 /* XXX BPF uses ro_prepend */
 302                 if (ro->ro_prepend != NULL) {
 303                         phdr = ro->ro_prepend;
 304                         hlen = ro->ro_plen;
 305                 } else if (!(m->m_flags & (M_BCAST | M_MCAST))) {
 306                         if ((ro->ro_flags & RT_LLE_CACHE) != 0) {
 307                                 lle = ro->ro_lle;
 308                                 if (lle != NULL &&
 309                                     (lle->la_flags & LLE_VALID) == 0) {
 310                                         LLE_FREE(lle);
 311                                         lle = NULL;     /* redundant */
 312                                         ro->ro_lle = NULL;
 313                                 }
 314                                 if (lle == NULL) {
 315                                         /* if we lookup, keep cache */
 316                                         addref = 1;
 317                                 } else
 318                                         /*
 319                                          * Notify LLE code that
 320                                          * the entry was used
 321                                          * by datapath.
 322                                          */
 323                                         llentry_mark_used(lle);
 324                         }
 325                         if (lle != NULL) {
 326                                 phdr = lle->r_linkdata;
 327                                 hlen = lle->r_hdrlen;
 328                                 pflags = lle->r_flags;
 329                         }
 330                 }
 331         }
 332
 333 #ifdef MAC
 334         error = mac_ifnet_check_transmit(ifp, m);
 335         if (error)
 336                 senderr(error);
 337 #endif
 338
 339         M_PROFILE(m);
 340         if (ifp->if_flags & IFF_MONITOR)
 341                 senderr(ENETDOWN);
 342         if (!((ifp->if_flags & IFF_UP) &&
 343             (ifp->if_drv_flags & IFF_DRV_RUNNING)))
 344                 senderr(ENETDOWN);
 345
 346         if (phdr == NULL) {
 347                 /* No prepend data supplied. Try to calculate ourselves. */
 348                 phdr = linkhdr;
 349                 hlen = ETHER_HDR_LEN;
 350                 error = ether_resolve_addr(ifp, m, dst, ro, phdr, &pflags,
 351                     addref ? &lle : NULL);
 352                 if (addref && lle != NULL)
 353                         ro->ro_lle = lle;
 354                 if (error != 0)
 355                         return (error == EWOULDBLOCK ? 0 : error);
 356         }
 357
 358         if ((pflags & RT_L2_ME) != 0) {
 359                 update_mbuf_csumflags(m, m);
 360                 return (if_simloop(ifp, m, dst->sa_family, 0));
 361         }
 362         loop_copy = pflags & RT_MAY_LOOP;
 363
 364         /*
 365          * Add local net header.  If no space in first mbuf,
 366          * allocate another.
 367          *
 368          * Note that we do prepend regardless of RT_HAS_HEADER flag.
 369          * This is done because BPF code shifts m_data pointer
 370          * to the end of ethernet header prior to calling if_output().
 371          */
 372         M_PREPEND(m, hlen, M_NOWAIT);
 373         if (m == NULL)
 374                 senderr(ENOBUFS);
 375         if ((pflags & RT_HAS_HEADER) == 0) {
 376                 eh = mtod(m, struct ether_header *);
 377                 memcpy(eh, phdr, hlen);
 378         }
 379
 380         /*
 381          * If a simplex interface, and the packet is being sent to our
 382          * Ethernet address or a broadcast address, loopback a copy.
 383          * XXX To make a simplex device behave exactly like a duplex
 384          * device, we should copy in the case of sending to our own
 385          * ethernet address (thus letting the original actually appear
 386          * on the wire). However, we don't do that here for security
 387          * reasons and compatibility with the original behavior.
 388          */
 389         if ((m->m_flags & M_BCAST) && loop_copy && (ifp->if_flags & IFF_SIMPLEX) &&
 390             ((t = pf_find_mtag(m)) == NULL || !t->routed)) {
 391                 struct mbuf *n;
 392
 393                 /*
 394                  * Because if_simloop() modifies the packet, we need a
 395                  * writable copy through m_dup() instead of a readonly
 396                  * one as m_copy[m] would give us. The alternative would
 397                  * be to modify if_simloop() to handle the readonly mbuf,
 398                  * but performancewise it is mostly equivalent (trading
 399                  * extra data copying vs. extra locking).
 400                  *
 401                  * XXX This is a local workaround.  A number of less
 402                  * often used kernel parts suffer from the same bug.
 403                  * See PR kern/105943 for a proposed general solution.
 404                  */
 405                 if ((n = m_dup(m, M_NOWAIT)) != NULL) {
 406                         update_mbuf_csumflags(m, n);
 407                         (void)if_simloop(ifp, n, dst->sa_family, hlen);
 408                 } else
 409                         if_inc_counter(ifp, IFCOUNTER_IQDROPS, 1);
 410         }
 411
 412        /*
 413         * Bridges require special output handling.
 414         */
 415         if (ifp->if_bridge) {
 416                 BRIDGE_OUTPUT(ifp, m, error);
 417                 return (error);
 418         }
 419
 420 #if defined(INET) || defined(INET6)
 421         if (ifp->if_carp &&
 422             (error = (*carp_output_p)(ifp, m, dst)))
 423                 goto bad;
 424 #endif
 425
 426         /* Handle ng_ether(4) processing, if any */
 427         if (ifp->if_l2com != NULL) {
 428                 KASSERT(ng_ether_output_p != NULL,
 429                     ("ng_ether_output_p is NULL"));
 430                 if ((error = (*ng_ether_output_p)(ifp, &m)) != 0) {
 431 bad:                    if (m != NULL)
 432                                 m_freem(m);
 433                         return (error);
 434                 }
 435                 if (m == NULL)
 436                         return (0);
 437         }
 438
 439         /* Continue with link-layer output */
 440         return ether_output_frame(ifp, m);
 441 }
 442
 443 static bool
 444 ether_set_pcp(struct mbuf **mp, struct ifnet *ifp, uint8_t pcp)
 445 {
 446         struct ether_header *eh;
 447
 448         eh = mtod(*mp, struct ether_header *);
 449         if (ntohs(eh->ether_type) == ETHERTYPE_VLAN ||
 450             ether_8021q_frame(mp, ifp, ifp, 0, pcp))
 451                 return (true);
 452         if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
 453         return (false);
 454 }
 455
 456 /*
 457  * Ethernet link layer output routine to send a raw frame to the device.
 458  *
 459  * This assumes that the 14 byte Ethernet header is present and contiguous
 460  * in the first mbuf (if BRIDGE'ing).
 461  */
 462 int
 463 ether_output_frame(struct ifnet *ifp, struct mbuf *m)
 464 {
 465         int error;
 466         uint8_t pcp;
 467
 468         pcp = ifp->if_pcp;
 469         if (pcp != IFNET_PCP_NONE && ifp->if_type != IFT_L2VLAN &&
 470             !ether_set_pcp(&m, ifp, pcp))
 471                 return (0);
 472
 473         if (PFIL_HOOKED(&V_link_pfil_hook)) {
 474                 error = pfil_run_hooks(&V_link_pfil_hook, &m, ifp,
 475                     PFIL_OUT, 0, NULL);
 476                 if (error != 0)
 477                         return (EACCES);
 478
 479                 if (m == NULL)
 480                         return (0);
 481         }
 482
 483         /*
 484          * Queue message on interface, update output statistics if
 485          * successful, and start output if interface not yet active.
 486          */
 487         return ((ifp->if_transmit)(ifp, m));
 488 }
 489
 490 /*
 491  * Process a received Ethernet packet; the packet is in the
 492  * mbuf chain m with the ethernet header at the front.
 493  */
 494 static void
 495 ether_input_internal(struct ifnet *ifp, struct mbuf *m)
 496 {
 497         struct ether_header *eh;
 498         u_short etype;
 499
 500         if ((ifp->if_flags & IFF_UP) == 0) {
 501                 m_freem(m);
 502                 return;
 503         }
 504 #ifdef DIAGNOSTIC
 505         if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0) {
 506                 if_printf(ifp, "discard frame at !IFF_DRV_RUNNING\n");
 507                 m_freem(m);
 508                 return;
 509         }
 510 #endif
 511         if (m->m_len < ETHER_HDR_LEN) {
 512                 /* XXX maybe should pullup? */
 513                 if_printf(ifp, "discard frame w/o leading ethernet "
 514                                 "header (len %u pkt len %u)\n",
 515                                 m->m_len, m->m_pkthdr.len);
 516                 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
 517                 m_freem(m);
 518                 return;
 519         }
 520         eh = mtod(m, struct ether_header *);
 521         etype = ntohs(eh->ether_type);
 522         random_harvest_queue_ether(m, sizeof(*m));
 523
 524         CURVNET_SET_QUIET(ifp->if_vnet);
 525
 526         if (ETHER_IS_MULTICAST(eh->ether_dhost)) {
 527                 if (ETHER_IS_BROADCAST(eh->ether_dhost))
 528                         m->m_flags |= M_BCAST;
 529                 else
 530                         m->m_flags |= M_MCAST;
 531                 if_inc_counter(ifp, IFCOUNTER_IMCASTS, 1);
 532         }
 533
 534 #ifdef MAC
 535         /*
 536          * Tag the mbuf with an appropriate MAC label before any other
 537          * consumers can get to it.
 538          */
 539         mac_ifnet_create_mbuf(ifp, m);
 540 #endif
 541
 542         /*
 543          * Give bpf a chance at the packet.
 544          */
 545         ETHER_BPF_MTAP(ifp, m);
 546
 547         /*
 548          * If the CRC is still on the packet, trim it off. We do this once
 549          * and once only in case we are re-entered. Nothing else on the
 550          * Ethernet receive path expects to see the FCS.
 551          */
 552         if (m->m_flags & M_HASFCS) {
 553                 m_adj(m, -ETHER_CRC_LEN);
 554                 m->m_flags &= ~M_HASFCS;
 555         }
 556
 557         if (!(ifp->if_capenable & IFCAP_HWSTATS))
 558                 if_inc_counter(ifp, IFCOUNTER_IBYTES, m->m_pkthdr.len);
 559
 560         /* Allow monitor mode to claim this frame, after stats are updated. */
 561         if (ifp->if_flags & IFF_MONITOR) {
 562                 m_freem(m);
 563                 CURVNET_RESTORE();
 564                 return;
 565         }
 566
 567         /* Handle input from a lagg(4) port */
 568         if (ifp->if_type == IFT_IEEE8023ADLAG) {
 569                 KASSERT(lagg_input_p != NULL,
 570                     ("%s: if_lagg not loaded!", __func__));
 571                 m = (*lagg_input_p)(ifp, m);
 572                 if (m != NULL)
 573                         ifp = m->m_pkthdr.rcvif;
 574                 else {
 575                         CURVNET_RESTORE();
 576                         return;
 577                 }
 578         }
 579
 580         /*
 581          * If the hardware did not process an 802.1Q tag, do this now,
 582          * to allow 802.1P priority frames to be passed to the main input
 583          * path correctly.
 584          * TODO: Deal with Q-in-Q frames, but not arbitrary nesting levels.
 585          */
 586         if ((m->m_flags & M_VLANTAG) == 0 && etype == ETHERTYPE_VLAN) {
 587                 struct ether_vlan_header *evl;
 588
 589                 if (m->m_len < sizeof(*evl) &&
 590                     (m = m_pullup(m, sizeof(*evl))) == NULL) {
 591 #ifdef DIAGNOSTIC
 592                         if_printf(ifp, "cannot pullup VLAN header\n");
 593 #endif
 594                         if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
 595                         CURVNET_RESTORE();
 596                         return;
 597                 }
 598
 599                 evl = mtod(m, struct ether_vlan_header *);
 600                 m->m_pkthdr.ether_vtag = ntohs(evl->evl_tag);
 601                 m->m_flags |= M_VLANTAG;
 602
 603                 bcopy((char *)evl, (char *)evl + ETHER_VLAN_ENCAP_LEN,
 604                     ETHER_HDR_LEN - ETHER_TYPE_LEN);
 605                 m_adj(m, ETHER_VLAN_ENCAP_LEN);
 606                 eh = mtod(m, struct ether_header *);
 607         }
 608
 609         M_SETFIB(m, ifp->if_fib);
 610
 611         /* Allow ng_ether(4) to claim this frame. */
 612         if (ifp->if_l2com != NULL) {
 613                 KASSERT(ng_ether_input_p != NULL,
 614                     ("%s: ng_ether_input_p is NULL", __func__));
 615                 m->m_flags &= ~M_PROMISC;
 616                 (*ng_ether_input_p)(ifp, &m);
 617                 if (m == NULL) {
 618                         CURVNET_RESTORE();
 619                         return;
 620                 }
 621                 eh = mtod(m, struct ether_header *);
 622         }
 623
 624         /*
 625          * Allow if_bridge(4) to claim this frame.
 626          * The BRIDGE_INPUT() macro will update ifp if the bridge changed it
 627          * and the frame should be delivered locally.
 628          */
 629         if (ifp->if_bridge != NULL) {
 630                 m->m_flags &= ~M_PROMISC;
 631                 BRIDGE_INPUT(ifp, m);
 632                 if (m == NULL) {
 633                         CURVNET_RESTORE();
 634                         return;
 635                 }
 636                 eh = mtod(m, struct ether_header *);
 637         }
 638
 639 #if defined(INET) || defined(INET6)
 640         /*
 641          * Clear M_PROMISC on frame so that carp(4) will see it when the
 642          * mbuf flows up to Layer 3.
 643          * FreeBSD's implementation of carp(4) uses the inprotosw
 644          * to dispatch IPPROTO_CARP. carp(4) also allocates its own
 645          * Ethernet addresses of the form 00:00:5e:00:01:xx, which
 646          * is outside the scope of the M_PROMISC test below.
 647          * TODO: Maintain a hash table of ethernet addresses other than
 648          * ether_dhost which may be active on this ifp.
 649          */
 650         if (ifp->if_carp && (*carp_forus_p)(ifp, eh->ether_dhost)) {
 651                 m->m_flags &= ~M_PROMISC;
 652         } else
 653 #endif
 654         {
 655                 /*
 656                  * If the frame received was not for our MAC address, set the
 657                  * M_PROMISC flag on the mbuf chain. The frame may need to
 658                  * be seen by the rest of the Ethernet input path in case of
 659                  * re-entry (e.g. bridge, vlan, netgraph) but should not be
 660                  * seen by upper protocol layers.
 661                  */
 662                 if (!ETHER_IS_MULTICAST(eh->ether_dhost) &&
 663                     bcmp(IF_LLADDR(ifp), eh->ether_dhost, ETHER_ADDR_LEN) != 0)
 664                         m->m_flags |= M_PROMISC;
 665         }
 666
 667         ether_demux(ifp, m);
 668         CURVNET_RESTORE();
 669 }
 670
 671 /*
 672  * Ethernet input dispatch; by default, direct dispatch here regardless of
 673  * global configuration.  However, if RSS is enabled, hook up RSS affinity
 674  * so that when deferred or hybrid dispatch is enabled, we can redistribute
 675  * load based on RSS.
 676  *
 677  * XXXRW: Would be nice if the ifnet passed up a flag indicating whether or
 678  * not it had already done work distribution via multi-queue.  Then we could
 679  * direct dispatch in the event load balancing was already complete and
 680  * handle the case of interfaces with different capabilities better.
 681  *
 682  * XXXRW: Sort of want an M_DISTRIBUTED flag to avoid multiple distributions
 683  * at multiple layers?
 684  *
 685  * XXXRW: For now, enable all this only if RSS is compiled in, although it
 686  * works fine without RSS.  Need to characterise the performance overhead
 687  * of the detour through the netisr code in the event the result is always
 688  * direct dispatch.
 689  */
 690 static void
 691 ether_nh_input(struct mbuf *m)
 692 {
 693
 694         M_ASSERTPKTHDR(m);
 695         KASSERT(m->m_pkthdr.rcvif != NULL,
 696             ("%s: NULL interface pointer", __func__));
 697         ether_input_internal(m->m_pkthdr.rcvif, m);
 698 }
 699
 700 static struct netisr_handler    ether_nh = {
 701         .nh_name = "ether",
 702         .nh_handler = ether_nh_input,
 703         .nh_proto = NETISR_ETHER,
 704 #ifdef RSS
 705         .nh_policy = NETISR_POLICY_CPU,
 706         .nh_dispatch = NETISR_DISPATCH_DIRECT,
 707         .nh_m2cpuid = rss_m2cpuid,
 708 #else
 709         .nh_policy = NETISR_POLICY_SOURCE,
 710         .nh_dispatch = NETISR_DISPATCH_DIRECT,
 711 #endif
 712 };
 713
 714 static void
 715 ether_init(__unused void *arg)
 716 {
 717
 718         netisr_register(&ether_nh);
 719 }
 720 SYSINIT(ether, SI_SUB_INIT_IF, SI_ORDER_ANY, ether_init, NULL);
 721
 722 static void
 723 vnet_ether_init(__unused void *arg)
 724 {
 725         int i;
 726
 727         /* Initialize packet filter hooks. */
 728         V_link_pfil_hook.ph_type = PFIL_TYPE_AF;
 729         V_link_pfil_hook.ph_af = AF_LINK;
 730         if ((i = pfil_head_register(&V_link_pfil_hook)) != 0)
 731                 printf("%s: WARNING: unable to register pfil link hook, "
 732                         "error %d\n", __func__, i);
 733 #ifdef VIMAGE
 734         netisr_register_vnet(&ether_nh);
 735 #endif
 736 }
 737 VNET_SYSINIT(vnet_ether_init, SI_SUB_PROTO_IF, SI_ORDER_ANY,
 738     vnet_ether_init, NULL);
 739
 740 #ifdef VIMAGE
 741 static void
 742 vnet_ether_pfil_destroy(__unused void *arg)
 743 {
 744         int i;
 745
 746         if ((i = pfil_head_unregister(&V_link_pfil_hook)) != 0)
 747                 printf("%s: WARNING: unable to unregister pfil link hook, "
 748                         "error %d\n", __func__, i);
 749 }
 750 VNET_SYSUNINIT(vnet_ether_pfil_uninit, SI_SUB_PROTO_PFIL, SI_ORDER_ANY,
 751     vnet_ether_pfil_destroy, NULL);
 752
 753 static void
 754 vnet_ether_destroy(__unused void *arg)
 755 {
 756
 757         netisr_unregister_vnet(&ether_nh);
 758 }
 759 VNET_SYSUNINIT(vnet_ether_uninit, SI_SUB_PROTO_IF, SI_ORDER_ANY,
 760     vnet_ether_destroy, NULL);
 761 #endif
 762
 763
 764
 765 static void
 766 ether_input(struct ifnet *ifp, struct mbuf *m)
 767 {
 768
 769         struct mbuf *mn;
 770
 771         /*
 772          * The drivers are allowed to pass in a chain of packets linked with
 773          * m_nextpkt. We split them up into separate packets here and pass
 774          * them up. This allows the drivers to amortize the receive lock.
 775          */
 776         while (m) {
 777                 mn = m->m_nextpkt;
 778                 m->m_nextpkt = NULL;
 779
 780                 /*
 781                  * We will rely on rcvif being set properly in the deferred context,
 782                  * so assert it is correct here.
 783                  */
 784                 KASSERT(m->m_pkthdr.rcvif == ifp, ("%s: ifnet mismatch m %p "
 785                     "rcvif %p ifp %p", __func__, m, m->m_pkthdr.rcvif, ifp));
 786                 CURVNET_SET_QUIET(ifp->if_vnet);
 787                 netisr_dispatch(NETISR_ETHER, m);
 788                 CURVNET_RESTORE();
 789                 m = mn;
 790         }
 791 }
 792
 793 /*
 794  * Upper layer processing for a received Ethernet packet.
 795  */
 796 void
 797 ether_demux(struct ifnet *ifp, struct mbuf *m)
 798 {
 799         struct ether_header *eh;
 800         int i, isr;
 801         u_short ether_type;
 802
 803         KASSERT(ifp != NULL, ("%s: NULL interface pointer", __func__));
 804
 805         /* Do not grab PROMISC frames in case we are re-entered. */
 806         if (PFIL_HOOKED(&V_link_pfil_hook) && !(m->m_flags & M_PROMISC)) {
 807                 i = pfil_run_hooks(&V_link_pfil_hook, &m, ifp, PFIL_IN, 0,
 808                     NULL);
 809
 810                 if (i != 0 || m == NULL)
 811                         return;
 812         }
 813
 814         eh = mtod(m, struct ether_header *);
 815         ether_type = ntohs(eh->ether_type);
 816
 817         /*
 818          * If this frame has a VLAN tag other than 0, call vlan_input()
 819          * if its module is loaded. Otherwise, drop.
 820          */
 821         if ((m->m_flags & M_VLANTAG) &&
 822             EVL_VLANOFTAG(m->m_pkthdr.ether_vtag) != 0) {
 823                 if (ifp->if_vlantrunk == NULL) {
 824                         if_inc_counter(ifp, IFCOUNTER_NOPROTO, 1);
 825                         m_freem(m);
 826                         return;
 827                 }
 828                 KASSERT(vlan_input_p != NULL,("%s: VLAN not loaded!",
 829                     __func__));
 830                 /* Clear before possibly re-entering ether_input(). */
 831                 m->m_flags &= ~M_PROMISC;
 832                 (*vlan_input_p)(ifp, m);
 833                 return;
 834         }
 835
 836         /*
 837          * Pass promiscuously received frames to the upper layer if the user
 838          * requested this by setting IFF_PPROMISC. Otherwise, drop them.
 839          */
 840         if ((ifp->if_flags & IFF_PPROMISC) == 0 && (m->m_flags & M_PROMISC)) {
 841                 m_freem(m);
 842                 return;
 843         }
 844
 845         /*
 846          * Reset layer specific mbuf flags to avoid confusing upper layers.
 847          * Strip off Ethernet header.
 848          */
 849         m->m_flags &= ~M_VLANTAG;
 850         m_clrprotoflags(m);
 851         m_adj(m, ETHER_HDR_LEN);
 852
 853         /*
 854          * Dispatch frame to upper layer.
 855          */
 856         switch (ether_type) {
 857 #ifdef INET
 858         case ETHERTYPE_IP:
 859                 isr = NETISR_IP;
 860                 break;
 861
 862         case ETHERTYPE_ARP:
 863                 if (ifp->if_flags & IFF_NOARP) {
 864                         /* Discard packet if ARP is disabled on interface */
 865                         m_freem(m);
 866                         return;
 867                 }
 868                 isr = NETISR_ARP;
 869                 break;
 870 #endif
 871 #ifdef INET6
 872         case ETHERTYPE_IPV6:
 873                 isr = NETISR_IPV6;
 874                 break;
 875 #endif
 876         default:
 877                 goto discard;
 878         }
 879         netisr_dispatch(isr, m);
 880         return;
 881
 882 discard:
 883         /*
 884          * Packet is to be discarded.  If netgraph is present,
 885          * hand the packet to it for last chance processing;
 886          * otherwise dispose of it.
 887          */
 888         if (ifp->if_l2com != NULL) {
 889                 KASSERT(ng_ether_input_orphan_p != NULL,
 890                     ("ng_ether_input_orphan_p is NULL"));
 891                 /*
 892                  * Put back the ethernet header so netgraph has a
 893                  * consistent view of inbound packets.
 894                  */
 895                 M_PREPEND(m, ETHER_HDR_LEN, M_NOWAIT);
 896                 (*ng_ether_input_orphan_p)(ifp, m);
 897                 return;
 898         }
 899         m_freem(m);
 900 }
 901
 902 /*
 903  * Convert Ethernet address to printable (loggable) representation.
 904  * This routine is for compatibility; it's better to just use
 905  *
 906  *      printf("%6D", <pointer to address>, ":");
 907  *
 908  * since there's no static buffer involved.
 909  */
 910 char *
 911 ether_sprintf(const u_char *ap)
 912 {
 913         static char etherbuf[18];
 914         snprintf(etherbuf, sizeof (etherbuf), "%6D", ap, ":");
 915         return (etherbuf);
 916 }
 917
 918 /*
 919  * Perform common duties while attaching to interface list
 920  */
 921 void
 922 ether_ifattach(struct ifnet *ifp, const u_int8_t *lla)
 923 {
 924         int i;
 925         struct ifaddr *ifa;
 926         struct sockaddr_dl *sdl;
 927
 928         ifp->if_addrlen = ETHER_ADDR_LEN;
 929         ifp->if_hdrlen = ETHER_HDR_LEN;
 930         if_attach(ifp);
 931         ifp->if_mtu = ETHERMTU;
 932         ifp->if_output = ether_output;
 933         ifp->if_input = ether_input;
 934         ifp->if_resolvemulti = ether_resolvemulti;
 935         ifp->if_requestencap = ether_requestencap;
 936 #ifdef VIMAGE
 937         ifp->if_reassign = ether_reassign;
 938 #endif
 939         if (ifp->if_baudrate == 0)
 940                 ifp->if_baudrate = IF_Mbps(10);         /* just a default */
 941         ifp->if_broadcastaddr = etherbroadcastaddr;
 942
 943         ifa = ifp->if_addr;
 944         KASSERT(ifa != NULL, ("%s: no lladdr!\n", __func__));
 945         sdl = (struct sockaddr_dl *)ifa->ifa_addr;
 946         sdl->sdl_type = IFT_ETHER;
 947         sdl->sdl_alen = ifp->if_addrlen;
 948         bcopy(lla, LLADDR(sdl), ifp->if_addrlen);
 949
 950         if (ifp->if_hw_addr != NULL)
 951                 bcopy(lla, ifp->if_hw_addr, ifp->if_addrlen);
 952
 953         bpfattach(ifp, DLT_EN10MB, ETHER_HDR_LEN);
 954         if (ng_ether_attach_p != NULL)
 955                 (*ng_ether_attach_p)(ifp);
 956
 957         /* Announce Ethernet MAC address if non-zero. */
 958         for (i = 0; i < ifp->if_addrlen; i++)
 959                 if (lla[i] != 0)
 960                         break;
 961         if (i != ifp->if_addrlen)
 962                 if_printf(ifp, "Ethernet address: %6D\n", lla, ":");
 963
 964         uuid_ether_add(LLADDR(sdl));
 965
 966         /* Add necessary bits are setup; announce it now. */
 967         EVENTHANDLER_INVOKE(ether_ifattach_event, ifp);
 968         if (IS_DEFAULT_VNET(curvnet))
 969                 devctl_notify("ETHERNET", ifp->if_xname, "IFATTACH", NULL);
 970 }
 971
 972 /*
 973  * Perform common duties while detaching an Ethernet interface
 974  */
 975 void
 976 ether_ifdetach(struct ifnet *ifp)
 977 {
 978         struct sockaddr_dl *sdl;
 979
 980         sdl = (struct sockaddr_dl *)(ifp->if_addr->ifa_addr);
 981         uuid_ether_del(LLADDR(sdl));
 982
 983         if (ifp->if_l2com != NULL) {
 984                 KASSERT(ng_ether_detach_p != NULL,
 985                     ("ng_ether_detach_p is NULL"));
 986                 (*ng_ether_detach_p)(ifp);
 987         }
 988
 989         bpfdetach(ifp);
 990         if_detach(ifp);
 991 }
 992
 993 #ifdef VIMAGE
 994 void
 995 ether_reassign(struct ifnet *ifp, struct vnet *new_vnet, char *unused __unused)
 996 {
 997
 998         if (ifp->if_l2com != NULL) {
 999                 KASSERT(ng_ether_detach_p != NULL,
1000                     ("ng_ether_detach_p is NULL"));
1001                 (*ng_ether_detach_p)(ifp);
1002         }
1003
1004         if (ng_ether_attach_p != NULL) {
1005                 CURVNET_SET_QUIET(new_vnet);
1006                 (*ng_ether_attach_p)(ifp);
1007                 CURVNET_RESTORE();
1008         }
1009 }
1010 #endif
1011
1012 SYSCTL_DECL(_net_link);
1013 SYSCTL_NODE(_net_link, IFT_ETHER, ether, CTLFLAG_RW, 0, "Ethernet");
1014
1015 #if 0
1016 /*
1017  * This is for reference.  We have a table-driven version
1018  * of the little-endian crc32 generator, which is faster
1019  * than the double-loop.
1020  */
1021 uint32_t
1022 ether_crc32_le(const uint8_t *buf, size_t len)
1023 {
1024         size_t i;
1025         uint32_t crc;
1026         int bit;
1027         uint8_t data;
1028
1029         crc = 0xffffffff;       /* initial value */
1030
1031         for (i = 0; i < len; i++) {
1032                 for (data = *buf++, bit = 0; bit < 8; bit++, data >>= 1) {
1033                         carry = (crc ^ data) & 1;
1034                         crc >>= 1;
1035                         if (carry)
1036                                 crc = (crc ^ ETHER_CRC_POLY_LE);
1037                 }
1038         }
1039
1040         return (crc);
1041 }
1042 #else
1043 uint32_t
1044 ether_crc32_le(const uint8_t *buf, size_t len)
1045 {
1046         static const uint32_t crctab[] = {
1047                 0x00000000, 0x1db71064, 0x3b6e20c8, 0x26d930ac,
1048                 0x76dc4190, 0x6b6b51f4, 0x4db26158, 0x5005713c,
1049                 0xedb88320, 0xf00f9344, 0xd6d6a3e8, 0xcb61b38c,
1050                 0x9b64c2b0, 0x86d3d2d4, 0xa00ae278, 0xbdbdf21c
1051         };
1052         size_t i;
1053         uint32_t crc;
1054
1055         crc = 0xffffffff;       /* initial value */
1056
1057         for (i = 0; i < len; i++) {
1058                 crc ^= buf[i];
1059                 crc = (crc >> 4) ^ crctab[crc & 0xf];
1060                 crc = (crc >> 4) ^ crctab[crc & 0xf];
1061         }
1062
1063         return (crc);
1064 }
1065 #endif
1066
1067 uint32_t
1068 ether_crc32_be(const uint8_t *buf, size_t len)
1069 {
1070         size_t i;
1071         uint32_t crc, carry;
1072         int bit;
1073         uint8_t data;
1074
1075         crc = 0xffffffff;       /* initial value */
1076
1077         for (i = 0; i < len; i++) {
1078                 for (data = *buf++, bit = 0; bit < 8; bit++, data >>= 1) {
1079                         carry = ((crc & 0x80000000) ? 1 : 0) ^ (data & 0x01);
1080                         crc <<= 1;
1081                         if (carry)
1082                                 crc = (crc ^ ETHER_CRC_POLY_BE) | carry;
1083                 }
1084         }
1085
1086         return (crc);
1087 }
1088
1089 int
1090 ether_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
1091 {
1092         struct ifaddr *ifa = (struct ifaddr *) data;
1093         struct ifreq *ifr = (struct ifreq *) data;
1094         int error = 0;
1095
1096         switch (command) {
1097         case SIOCSIFADDR:
1098                 ifp->if_flags |= IFF_UP;
1099
1100                 switch (ifa->ifa_addr->sa_family) {
1101 #ifdef INET
1102                 case AF_INET:
1103                         ifp->if_init(ifp->if_softc);    /* before arpwhohas */
1104                         arp_ifinit(ifp, ifa);
1105                         break;
1106 #endif
1107                 default:
1108                         ifp->if_init(ifp->if_softc);
1109                         break;
1110                 }
1111                 break;
1112
1113         case SIOCGIFADDR:
1114                 bcopy(IF_LLADDR(ifp), &ifr->ifr_addr.sa_data[0],
1115                     ETHER_ADDR_LEN);
1116                 break;
1117
1118         case SIOCSIFMTU:
1119                 /*
1120                  * Set the interface MTU.
1121                  */
1122                 if (ifr->ifr_mtu > ETHERMTU) {
1123                         error = EINVAL;
1124                 } else {
1125                         ifp->if_mtu = ifr->ifr_mtu;
1126                 }
1127                 break;
1128
1129         case SIOCSLANPCP:
1130                 error = priv_check(curthread, PRIV_NET_SETLANPCP);
1131                 if (error != 0)
1132                         break;
1133                 if (ifr->ifr_lan_pcp > 7 &&
1134                     ifr->ifr_lan_pcp != IFNET_PCP_NONE) {
1135                         error = EINVAL;
1136                 } else {
1137                         ifp->if_pcp = ifr->ifr_lan_pcp;
1138                         /* broadcast event about PCP change */
1139                         EVENTHANDLER_INVOKE(ifnet_event, ifp, IFNET_EVENT_PCP);
1140                 }
1141                 break;
1142
1143         case SIOCGLANPCP:
1144                 ifr->ifr_lan_pcp = ifp->if_pcp;
1145                 break;
1146
1147         default:
1148                 error = EINVAL;                 /* XXX netbsd has ENOTTY??? */
1149                 break;
1150         }
1151         return (error);
1152 }
1153
1154 static int
1155 ether_resolvemulti(struct ifnet *ifp, struct sockaddr **llsa,
1156         struct sockaddr *sa)
1157 {
1158         struct sockaddr_dl *sdl;
1159 #ifdef INET
1160         struct sockaddr_in *sin;
1161 #endif
1162 #ifdef INET6
1163         struct sockaddr_in6 *sin6;
1164 #endif
1165         u_char *e_addr;
1166
1167         switch(sa->sa_family) {
1168         case AF_LINK:
1169                 /*
1170                  * No mapping needed. Just check that it's a valid MC address.
1171                  */
1172                 sdl = (struct sockaddr_dl *)sa;
1173                 e_addr = LLADDR(sdl);
1174                 if (!ETHER_IS_MULTICAST(e_addr))
1175                         return EADDRNOTAVAIL;
1176                 *llsa = NULL;
1177                 return 0;
1178
1179 #ifdef INET
1180         case AF_INET:
1181                 sin = (struct sockaddr_in *)sa;
1182                 if (!IN_MULTICAST(ntohl(sin->sin_addr.s_addr)))
1183                         return EADDRNOTAVAIL;
1184                 sdl = link_init_sdl(ifp, *llsa, IFT_ETHER);
1185                 sdl->sdl_alen = ETHER_ADDR_LEN;
1186                 e_addr = LLADDR(sdl);
1187                 ETHER_MAP_IP_MULTICAST(&sin->sin_addr, e_addr);
1188                 *llsa = (struct sockaddr *)sdl;
1189                 return 0;
1190 #endif
1191 #ifdef INET6
1192         case AF_INET6:
1193                 sin6 = (struct sockaddr_in6 *)sa;
1194                 if (IN6_IS_ADDR_UNSPECIFIED(&sin6->sin6_addr)) {
1195                         /*
1196                          * An IP6 address of 0 means listen to all
1197                          * of the Ethernet multicast address used for IP6.
1198                          * (This is used for multicast routers.)
1199                          */
1200                         ifp->if_flags |= IFF_ALLMULTI;
1201                         *llsa = NULL;
1202                         return 0;
1203                 }
1204                 if (!IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr))
1205                         return EADDRNOTAVAIL;
1206                 sdl = link_init_sdl(ifp, *llsa, IFT_ETHER);
1207                 sdl->sdl_alen = ETHER_ADDR_LEN;
1208                 e_addr = LLADDR(sdl);
1209                 ETHER_MAP_IPV6_MULTICAST(&sin6->sin6_addr, e_addr);
1210                 *llsa = (struct sockaddr *)sdl;
1211                 return 0;
1212 #endif
1213
1214         default:
1215                 /*
1216                  * Well, the text isn't quite right, but it's the name
1217                  * that counts...
1218                  */
1219                 return EAFNOSUPPORT;
1220         }
1221 }
1222
1223 static moduledata_t ether_mod = {
1224         .name = "ether",
1225 };
1226
1227 void
1228 ether_vlan_mtap(struct bpf_if *bp, struct mbuf *m, void *data, u_int dlen)
1229 {
1230         struct ether_vlan_header vlan;
1231         struct mbuf mv, mb;
1232
1233         KASSERT((m->m_flags & M_VLANTAG) != 0,
1234             ("%s: vlan information not present", __func__));
1235         KASSERT(m->m_len >= sizeof(struct ether_header),
1236             ("%s: mbuf not large enough for header", __func__));
1237         bcopy(mtod(m, char *), &vlan, sizeof(struct ether_header));
1238         vlan.evl_proto = vlan.evl_encap_proto;
1239         vlan.evl_encap_proto = htons(ETHERTYPE_VLAN);
1240         vlan.evl_tag = htons(m->m_pkthdr.ether_vtag);
1241         m->m_len -= sizeof(struct ether_header);
1242         m->m_data += sizeof(struct ether_header);
1243         /*
1244          * If a data link has been supplied by the caller, then we will need to
1245          * re-create a stack allocated mbuf chain with the following structure:
1246          *
1247          * (1) mbuf #1 will contain the supplied data link
1248          * (2) mbuf #2 will contain the vlan header
1249          * (3) mbuf #3 will contain the original mbuf's packet data
1250          *
1251          * Otherwise, submit the packet and vlan header via bpf_mtap2().
1252          */
1253         if (data != NULL) {
1254                 mv.m_next = m;
1255                 mv.m_data = (caddr_t)&vlan;
1256                 mv.m_len = sizeof(vlan);
1257                 mb.m_next = &mv;
1258                 mb.m_data = data;
1259                 mb.m_len = dlen;
1260                 bpf_mtap(bp, &mb);
1261         } else
1262                 bpf_mtap2(bp, &vlan, sizeof(vlan), m);
1263         m->m_len += sizeof(struct ether_header);
1264         m->m_data -= sizeof(struct ether_header);
1265 }
1266
1267 struct mbuf *
1268 ether_vlanencap(struct mbuf *m, uint16_t tag)
1269 {
1270         struct ether_vlan_header *evl;
1271
1272         M_PREPEND(m, ETHER_VLAN_ENCAP_LEN, M_NOWAIT);
1273         if (m == NULL)
1274                 return (NULL);
1275         /* M_PREPEND takes care of m_len, m_pkthdr.len for us */
1276
1277         if (m->m_len < sizeof(*evl)) {
1278                 m = m_pullup(m, sizeof(*evl));
1279                 if (m == NULL)
1280                         return (NULL);
1281         }
1282
1283         /*
1284          * Transform the Ethernet header into an Ethernet header
1285          * with 802.1Q encapsulation.
1286          */
1287         evl = mtod(m, struct ether_vlan_header *);
1288         bcopy((char *)evl + ETHER_VLAN_ENCAP_LEN,
1289             (char *)evl, ETHER_HDR_LEN - ETHER_TYPE_LEN);
1290         evl->evl_encap_proto = htons(ETHERTYPE_VLAN);
1291         evl->evl_tag = htons(tag);
1292         return (m);
1293 }
1294
1295 static SYSCTL_NODE(_net_link, IFT_L2VLAN, vlan, CTLFLAG_RW, 0,
1296     "IEEE 802.1Q VLAN");
1297 static SYSCTL_NODE(_net_link_vlan, PF_LINK, link, CTLFLAG_RW, 0,
1298     "for consistency");
1299
1300 VNET_DEFINE_STATIC(int, soft_pad);
1301 #define V_soft_pad      VNET(soft_pad)
1302 SYSCTL_INT(_net_link_vlan, OID_AUTO, soft_pad, CTLFLAG_RW | CTLFLAG_VNET,
1303     &VNET_NAME(soft_pad), 0,
1304     "pad short frames before tagging");
1305
1306 /*
1307  * For now, make preserving PCP via an mbuf tag optional, as it increases
1308  * per-packet memory allocations and frees.  In the future, it would be
1309  * preferable to reuse ether_vtag for this, or similar.
1310  */
1311 int vlan_mtag_pcp = 0;
1312 SYSCTL_INT(_net_link_vlan, OID_AUTO, mtag_pcp, CTLFLAG_RW,
1313     &vlan_mtag_pcp, 0,
1314     "Retain VLAN PCP information as packets are passed up the stack");
1315
1316 bool
1317 ether_8021q_frame(struct mbuf **mp, struct ifnet *ife, struct ifnet *p,
1318     uint16_t vid, uint8_t pcp)
1319 {
1320         struct m_tag *mtag;
1321         int n;
1322         uint16_t tag;
1323         static const char pad[8];       /* just zeros */
1324
1325         /*
1326          * Pad the frame to the minimum size allowed if told to.
1327          * This option is in accord with IEEE Std 802.1Q, 2003 Ed.,
1328          * paragraph C.4.4.3.b.  It can help to work around buggy
1329          * bridges that violate paragraph C.4.4.3.a from the same
1330          * document, i.e., fail to pad short frames after untagging.
1331          * E.g., a tagged frame 66 bytes long (incl. FCS) is OK, but
1332          * untagging it will produce a 62-byte frame, which is a runt
1333          * and requires padding.  There are VLAN-enabled network
1334          * devices that just discard such runts instead or mishandle
1335          * them somehow.
1336          */
1337         if (V_soft_pad && p->if_type == IFT_ETHER) {
1338                 for (n = ETHERMIN + ETHER_HDR_LEN - (*mp)->m_pkthdr.len;
1339                      n > 0; n -= sizeof(pad)) {
1340                         if (!m_append(*mp, min(n, sizeof(pad)), pad))
1341                                 break;
1342                 }
1343                 if (n > 0) {
1344                         m_freem(*mp);
1345                         *mp = NULL;
1346                         if_printf(ife, "cannot pad short frame");
1347                         return (false);
1348                 }
1349         }
1350
1351         /*
1352          * If underlying interface can do VLAN tag insertion itself,
1353          * just pass the packet along. However, we need some way to
1354          * tell the interface where the packet came from so that it
1355          * knows how to find the VLAN tag to use, so we attach a
1356          * packet tag that holds it.
1357          */
1358         if (vlan_mtag_pcp && (mtag = m_tag_locate(*mp, MTAG_8021Q,
1359             MTAG_8021Q_PCP_OUT, NULL)) != NULL)
1360                 tag = EVL_MAKETAG(vid, *(uint8_t *)(mtag + 1), 0);
1361         else
1362                 tag = EVL_MAKETAG(vid, pcp, 0);
1363         if (p->if_capenable & IFCAP_VLAN_HWTAGGING) {
1364                 (*mp)->m_pkthdr.ether_vtag = tag;
1365                 (*mp)->m_flags |= M_VLANTAG;
1366         } else {
1367                 *mp = ether_vlanencap(*mp, tag);
1368                 if (*mp == NULL) {
1369                         if_printf(ife, "unable to prepend 802.1Q header");
1370                         return (false);
1371                 }
1372         }
1373         return (true);
1374 }
1375
1376 /*
1377  * Allocate an address from the FreeBSD Foundation OUI.  This uses a
1378  * cryptographic hash function on the containing jail's UUID and the interface
1379  * name to attempt to provide a unique but stable address.  Pseudo-interfaces
1380  * which require a MAC address should use this function to allocate
1381  * non-locally-administered addresses.
1382  */
1383 void
1384 ether_gen_addr(struct ifnet *ifp, struct ether_addr *hwaddr)
1385 {
1386 #define ETHER_GEN_ADDR_BUFSIZ   HOSTUUIDLEN + IFNAMSIZ + 2
1387         SHA1_CTX ctx;
1388         char buf[ETHER_GEN_ADDR_BUFSIZ];
1389         char uuid[HOSTUUIDLEN + 1];
1390         uint64_t addr;
1391         int i, sz;
1392         char digest[SHA1_RESULTLEN];
1393
1394         getcredhostuuid(curthread->td_ucred, uuid, sizeof(uuid));
1395         sz = snprintf(buf, ETHER_GEN_ADDR_BUFSIZ, "%s-%s", uuid, ifp->if_xname);
1396         SHA1Init(&ctx);
1397         SHA1Update(&ctx, buf, sz);
1398         SHA1Final(digest, &ctx);
1399
1400         addr = ((digest[0] << 16) | (digest[1] << 8) | digest[2]) &
1401             OUI_FREEBSD_GENERATED_MASK;
1402         addr = OUI_FREEBSD(addr);
1403         for (i = 0; i < ETHER_ADDR_LEN; ++i) {
1404                 hwaddr->octet[i] = addr >> ((ETHER_ADDR_LEN - i - 1) * 8) &
1405                     0xFF;
1406         }
1407 }
1408
1409 DECLARE_MODULE(ether, ether_mod, SI_SUB_INIT_IF, SI_ORDER_ANY);
1410 MODULE_VERSION(ether, 1);