sys/net/if_vlan.c

   1 /*-
   2  * Copyright 1998 Massachusetts Institute of Technology
   3  *
   4  * Permission to use, copy, modify, and distribute this software and
   5  * its documentation for any purpose and without fee is hereby
   6  * granted, provided that both the above copyright notice and this
   7  * permission notice appear in all copies, that both the above
   8  * copyright notice and this permission notice appear in all
   9  * supporting documentation, and that the name of M.I.T. not be used
  10  * in advertising or publicity pertaining to distribution of the
  11  * software without specific, written prior permission.  M.I.T. makes
  12  * no representations about the suitability of this software for any
  13  * purpose.  It is provided "as is" without express or implied
  14  * warranty.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
  17  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
  18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
  20  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  23  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  26  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 /*
  33  * if_vlan.c - pseudo-device driver for IEEE 802.1Q virtual LANs.
  34  * Might be extended some day to also handle IEEE 802.1p priority
  35  * tagging.  This is sort of sneaky in the implementation, since
  36  * we need to pretend to be enough of an Ethernet implementation
  37  * to make arp work.  The way we do this is by telling everyone
  38  * that we are an Ethernet, and then catch the packets that
  39  * ether_output() left on our output queue when it calls
  40  * if_start(), rewrite them for use by the real outgoing interface,
  41  * and ask it to send them.
  42  */
  43
  44 #include "opt_vlan.h"
  45
  46 #include <sys/param.h>
  47 #include <sys/kernel.h>
  48 #include <sys/lock.h>
  49 #include <sys/malloc.h>
  50 #include <sys/mbuf.h>
  51 #include <sys/module.h>
  52 #include <sys/rwlock.h>
  53 #include <sys/queue.h>
  54 #include <sys/socket.h>
  55 #include <sys/sockio.h>
  56 #include <sys/sysctl.h>
  57 #include <sys/systm.h>
  58
  59 #include <net/bpf.h>
  60 #include <net/ethernet.h>
  61 #include <net/if.h>
  62 #include <net/if_clone.h>
  63 #include <net/if_dl.h>
  64 #include <net/if_types.h>
  65 #include <net/if_vlan_var.h>
  66
  67 #define VLANNAME        "vlan"
  68 #define VLAN_DEF_HWIDTH 4
  69 #define VLAN_IFFLAGS    (IFF_BROADCAST | IFF_MULTICAST)
  70
  71 #define UP_AND_RUNNING(ifp) \
  72     ((ifp)->if_flags & IFF_UP && (ifp)->if_drv_flags & IFF_DRV_RUNNING)
  73
  74 LIST_HEAD(ifvlanhead, ifvlan);
  75
  76 struct ifvlantrunk {
  77         struct  ifnet   *parent;        /* parent interface of this trunk */
  78         struct  rwlock  rw;
  79 #ifdef VLAN_ARRAY
  80 #define VLAN_ARRAY_SIZE (EVL_VLID_MASK + 1)
  81         struct  ifvlan  *vlans[VLAN_ARRAY_SIZE]; /* static table */
  82 #else
  83         struct  ifvlanhead *hash;       /* dynamic hash-list table */
  84         uint16_t        hmask;
  85         uint16_t        hwidth;
  86 #endif
  87         int             refcnt;
  88 };
  89
  90 struct vlan_mc_entry {
  91         struct ether_addr               mc_addr;
  92         SLIST_ENTRY(vlan_mc_entry)      mc_entries;
  93 };
  94
  95 struct  ifvlan {
  96         struct  ifvlantrunk *ifv_trunk;
  97         struct  ifnet *ifv_ifp;
  98 #define TRUNK(ifv)      ((ifv)->ifv_trunk)
  99 #define PARENT(ifv)     ((ifv)->ifv_trunk->parent)
 100         int     ifv_pflags;     /* special flags we have set on parent */
 101         struct  ifv_linkmib {
 102                 int     ifvm_encaplen;  /* encapsulation length */
 103                 int     ifvm_mtufudge;  /* MTU fudged by this much */
 104                 int     ifvm_mintu;     /* min transmission unit */
 105                 uint16_t ifvm_proto;    /* encapsulation ethertype */
 106                 uint16_t ifvm_tag;      /* tag to apply on packets leaving if */
 107         }       ifv_mib;
 108         SLIST_HEAD(, vlan_mc_entry) vlan_mc_listhead;
 109 #ifndef VLAN_ARRAY
 110         LIST_ENTRY(ifvlan) ifv_list;
 111 #endif
 112 };
 113 #define ifv_proto       ifv_mib.ifvm_proto
 114 #define ifv_tag         ifv_mib.ifvm_tag
 115 #define ifv_encaplen    ifv_mib.ifvm_encaplen
 116 #define ifv_mtufudge    ifv_mib.ifvm_mtufudge
 117 #define ifv_mintu       ifv_mib.ifvm_mintu
 118
 119 /* Special flags we should propagate to parent. */
 120 static struct {
 121         int flag;
 122         int (*func)(struct ifnet *, int);
 123 } vlan_pflags[] = {
 124         {IFF_PROMISC, ifpromisc},
 125         {IFF_ALLMULTI, if_allmulti},
 126         {0, NULL}
 127 };
 128
 129 SYSCTL_DECL(_net_link);
 130 SYSCTL_NODE(_net_link, IFT_L2VLAN, vlan, CTLFLAG_RW, 0, "IEEE 802.1Q VLAN");
 131 SYSCTL_NODE(_net_link_vlan, PF_LINK, link, CTLFLAG_RW, 0, "for consistency");
 132
 133 static int soft_pad = 0;
 134 SYSCTL_INT(_net_link_vlan, OID_AUTO, soft_pad, CTLFLAG_RW, &soft_pad, 0,
 135            "pad short frames before tagging");
 136
 137 static MALLOC_DEFINE(M_VLAN, VLANNAME, "802.1Q Virtual LAN Interface");
 138
 139 static eventhandler_tag ifdetach_tag;
 140
 141 /*
 142  * We have a global mutex, that is used to serialize configuration
 143  * changes and isn't used in normal packet delivery.
 144  *
 145  * We also have a per-trunk rwlock, that is locked shared on packet
 146  * processing and exclusive when configuration is changed.
 147  *
 148  * The VLAN_ARRAY substitutes the dynamic hash with a static array
 149  * with 4096 entries. In theory this can give a boost in processing,
 150  * however on practice it does not. Probably this is because array
 151  * is too big to fit into CPU cache.
 152  */
 153 static struct mtx ifv_mtx;
 154 #define VLAN_LOCK_INIT()        mtx_init(&ifv_mtx, "vlan_global", NULL, MTX_DEF)
 155 #define VLAN_LOCK_DESTROY()     mtx_destroy(&ifv_mtx)
 156 #define VLAN_LOCK_ASSERT()      mtx_assert(&ifv_mtx, MA_OWNED)
 157 #define VLAN_LOCK()             mtx_lock(&ifv_mtx)
 158 #define VLAN_UNLOCK()           mtx_unlock(&ifv_mtx)
 159 #define TRUNK_LOCK_INIT(trunk)  rw_init(&(trunk)->rw, VLANNAME)
 160 #define TRUNK_LOCK_DESTROY(trunk) rw_destroy(&(trunk)->rw)
 161 #define TRUNK_LOCK(trunk)       rw_wlock(&(trunk)->rw)
 162 #define TRUNK_UNLOCK(trunk)     rw_wunlock(&(trunk)->rw)
 163 #define TRUNK_LOCK_ASSERT(trunk) rw_assert(&(trunk)->rw, RA_WLOCKED)
 164 #define TRUNK_RLOCK(trunk)      rw_rlock(&(trunk)->rw)
 165 #define TRUNK_RUNLOCK(trunk)    rw_runlock(&(trunk)->rw)
 166 #define TRUNK_LOCK_RASSERT(trunk) rw_assert(&(trunk)->rw, RA_RLOCKED)
 167
 168 #ifndef VLAN_ARRAY
 169 static  void vlan_inithash(struct ifvlantrunk *trunk);
 170 static  void vlan_freehash(struct ifvlantrunk *trunk);
 171 static  int vlan_inshash(struct ifvlantrunk *trunk, struct ifvlan *ifv);
 172 static  int vlan_remhash(struct ifvlantrunk *trunk, struct ifvlan *ifv);
 173 static  void vlan_growhash(struct ifvlantrunk *trunk, int howmuch);
 174 static __inline struct ifvlan * vlan_gethash(struct ifvlantrunk *trunk,
 175         uint16_t tag);
 176 #endif
 177 static  void trunk_destroy(struct ifvlantrunk *trunk);
 178
 179 static  void vlan_start(struct ifnet *ifp);
 180 static  void vlan_init(void *foo);
 181 static  void vlan_input(struct ifnet *ifp, struct mbuf *m);
 182 static  int vlan_ioctl(struct ifnet *ifp, u_long cmd, caddr_t addr);
 183 static  int vlan_setflag(struct ifnet *ifp, int flag, int status,
 184     int (*func)(struct ifnet *, int));
 185 static  int vlan_setflags(struct ifnet *ifp, int status);
 186 static  int vlan_setmulti(struct ifnet *ifp);
 187 static  int vlan_unconfig(struct ifnet *ifp);
 188 static  int vlan_unconfig_locked(struct ifnet *ifp);
 189 static  int vlan_config(struct ifvlan *ifv, struct ifnet *p, uint16_t tag);
 190 static  void vlan_link_state(struct ifnet *ifp, int link);
 191 static  void vlan_capabilities(struct ifvlan *ifv);
 192 static  void vlan_trunk_capabilities(struct ifnet *ifp);
 193
 194 static  struct ifnet *vlan_clone_match_ethertag(struct if_clone *,
 195     const char *, int *);
 196 static  int vlan_clone_match(struct if_clone *, const char *);
 197 static  int vlan_clone_create(struct if_clone *, char *, size_t, caddr_t);
 198 static  int vlan_clone_destroy(struct if_clone *, struct ifnet *);
 199
 200 static  void vlan_ifdetach(void *arg, struct ifnet *ifp);
 201
 202 static  struct if_clone vlan_cloner = IFC_CLONE_INITIALIZER(VLANNAME, NULL,
 203     IF_MAXUNIT, NULL, vlan_clone_match, vlan_clone_create, vlan_clone_destroy);
 204
 205 #ifndef VLAN_ARRAY
 206 #define HASH(n, m)      ((((n) >> 8) ^ ((n) >> 4) ^ (n)) & (m))
 207
 208 static void
 209 vlan_inithash(struct ifvlantrunk *trunk)
 210 {
 211         int i, n;
 212
 213         /*
 214          * The trunk must not be locked here since we call malloc(M_WAITOK).
 215          * It is OK in case this function is called before the trunk struct
 216          * gets hooked up and becomes visible from other threads.
 217          */
 218
 219         KASSERT(trunk->hwidth == 0 && trunk->hash == NULL,
 220             ("%s: hash already initialized", __func__));
 221
 222         trunk->hwidth = VLAN_DEF_HWIDTH;
 223         n = 1 << trunk->hwidth;
 224         trunk->hmask = n - 1;
 225         trunk->hash = malloc(sizeof(struct ifvlanhead) * n, M_VLAN, M_WAITOK);
 226         for (i = 0; i < n; i++)
 227                 LIST_INIT(&trunk->hash[i]);
 228 }
 229
 230 static void
 231 vlan_freehash(struct ifvlantrunk *trunk)
 232 {
 233 #ifdef INVARIANTS
 234         int i;
 235
 236         KASSERT(trunk->hwidth > 0, ("%s: hwidth not positive", __func__));
 237         for (i = 0; i < (1 << trunk->hwidth); i++)
 238                 KASSERT(LIST_EMPTY(&trunk->hash[i]),
 239                     ("%s: hash table not empty", __func__));
 240 #endif
 241         free(trunk->hash, M_VLAN);
 242         trunk->hash = NULL;
 243         trunk->hwidth = trunk->hmask = 0;
 244 }
 245
 246 static int
 247 vlan_inshash(struct ifvlantrunk *trunk, struct ifvlan *ifv)
 248 {
 249         int i, b;
 250         struct ifvlan *ifv2;
 251
 252         TRUNK_LOCK_ASSERT(trunk);
 253         KASSERT(trunk->hwidth > 0, ("%s: hwidth not positive", __func__));
 254
 255         b = 1 << trunk->hwidth;
 256         i = HASH(ifv->ifv_tag, trunk->hmask);
 257         LIST_FOREACH(ifv2, &trunk->hash[i], ifv_list)
 258                 if (ifv->ifv_tag == ifv2->ifv_tag)
 259                         return (EEXIST);
 260
 261         /*
 262          * Grow the hash when the number of vlans exceeds half of the number of
 263          * hash buckets squared. This will make the average linked-list length
 264          * buckets/2.
 265          */
 266         if (trunk->refcnt > (b * b) / 2) {
 267                 vlan_growhash(trunk, 1);
 268                 i = HASH(ifv->ifv_tag, trunk->hmask);
 269         }
 270         LIST_INSERT_HEAD(&trunk->hash[i], ifv, ifv_list);
 271         trunk->refcnt++;
 272
 273         return (0);
 274 }
 275
 276 static int
 277 vlan_remhash(struct ifvlantrunk *trunk, struct ifvlan *ifv)
 278 {
 279         int i, b;
 280         struct ifvlan *ifv2;
 281
 282         TRUNK_LOCK_ASSERT(trunk);
 283         KASSERT(trunk->hwidth > 0, ("%s: hwidth not positive", __func__));
 284
 285         b = 1 << trunk->hwidth;
 286         i = HASH(ifv->ifv_tag, trunk->hmask);
 287         LIST_FOREACH(ifv2, &trunk->hash[i], ifv_list)
 288                 if (ifv2 == ifv) {
 289                         trunk->refcnt--;
 290                         LIST_REMOVE(ifv2, ifv_list);
 291                         if (trunk->refcnt < (b * b) / 2)
 292                                 vlan_growhash(trunk, -1);
 293                         return (0);
 294                 }
 295
 296         panic("%s: vlan not found\n", __func__);
 297         return (ENOENT); /*NOTREACHED*/
 298 }
 299
 300 /*
 301  * Grow the hash larger or smaller if memory permits.
 302  */
 303 static void
 304 vlan_growhash(struct ifvlantrunk *trunk, int howmuch)
 305 {
 306         struct ifvlan *ifv;
 307         struct ifvlanhead *hash2;
 308         int hwidth2, i, j, n, n2;
 309
 310         TRUNK_LOCK_ASSERT(trunk);
 311         KASSERT(trunk->hwidth > 0, ("%s: hwidth not positive", __func__));
 312
 313         if (howmuch == 0) {
 314                 /* Harmless yet obvious coding error */
 315                 printf("%s: howmuch is 0\n", __func__);
 316                 return;
 317         }
 318
 319         hwidth2 = trunk->hwidth + howmuch;
 320         n = 1 << trunk->hwidth;
 321         n2 = 1 << hwidth2;
 322         /* Do not shrink the table below the default */
 323         if (hwidth2 < VLAN_DEF_HWIDTH)
 324                 return;
 325
 326         /* M_NOWAIT because we're called with trunk mutex held */
 327         hash2 = malloc(sizeof(struct ifvlanhead) * n2, M_VLAN, M_NOWAIT);
 328         if (hash2 == NULL) {
 329                 printf("%s: out of memory -- hash size not changed\n",
 330                     __func__);
 331                 return;         /* We can live with the old hash table */
 332         }
 333         for (j = 0; j < n2; j++)
 334                 LIST_INIT(&hash2[j]);
 335         for (i = 0; i < n; i++)
 336                 while ((ifv = LIST_FIRST(&trunk->hash[i])) != NULL) {
 337                         LIST_REMOVE(ifv, ifv_list);
 338                         j = HASH(ifv->ifv_tag, n2 - 1);
 339                         LIST_INSERT_HEAD(&hash2[j], ifv, ifv_list);
 340                 }
 341         free(trunk->hash, M_VLAN);
 342         trunk->hash = hash2;
 343         trunk->hwidth = hwidth2;
 344         trunk->hmask = n2 - 1;
 345
 346         if (bootverbose)
 347                 if_printf(trunk->parent,
 348                     "VLAN hash table resized from %d to %d buckets\n", n, n2);
 349 }
 350
 351 static __inline struct ifvlan *
 352 vlan_gethash(struct ifvlantrunk *trunk, uint16_t tag)
 353 {
 354         struct ifvlan *ifv;
 355
 356         TRUNK_LOCK_RASSERT(trunk);
 357
 358         LIST_FOREACH(ifv, &trunk->hash[HASH(tag, trunk->hmask)], ifv_list)
 359                 if (ifv->ifv_tag == tag)
 360                         return (ifv);
 361         return (NULL);
 362 }
 363
 364 #if 0
 365 /* Debugging code to view the hashtables. */
 366 static void
 367 vlan_dumphash(struct ifvlantrunk *trunk)
 368 {
 369         int i;
 370         struct ifvlan *ifv;
 371
 372         for (i = 0; i < (1 << trunk->hwidth); i++) {
 373                 printf("%d: ", i);
 374                 LIST_FOREACH(ifv, &trunk->hash[i], ifv_list)
 375                         printf("%s ", ifv->ifv_ifp->if_xname);
 376                 printf("\n");
 377         }
 378 }
 379 #endif /* 0 */
 380 #endif /* !VLAN_ARRAY */
 381
 382 static void
 383 trunk_destroy(struct ifvlantrunk *trunk)
 384 {
 385         VLAN_LOCK_ASSERT();
 386
 387         TRUNK_LOCK(trunk);
 388 #ifndef VLAN_ARRAY
 389         vlan_freehash(trunk);
 390 #endif
 391         trunk->parent->if_vlantrunk = NULL;
 392         TRUNK_UNLOCK(trunk);
 393         TRUNK_LOCK_DESTROY(trunk);
 394         free(trunk, M_VLAN);
 395 }
 396
 397 /*
 398  * Program our multicast filter. What we're actually doing is
 399  * programming the multicast filter of the parent. This has the
 400  * side effect of causing the parent interface to receive multicast
 401  * traffic that it doesn't really want, which ends up being discarded
 402  * later by the upper protocol layers. Unfortunately, there's no way
 403  * to avoid this: there really is only one physical interface.
 404  *
 405  * XXX: There is a possible race here if more than one thread is
 406  *      modifying the multicast state of the vlan interface at the same time.
 407  */
 408 static int
 409 vlan_setmulti(struct ifnet *ifp)
 410 {
 411         struct ifnet            *ifp_p;
 412         struct ifmultiaddr      *ifma, *rifma = NULL;
 413         struct ifvlan           *sc;
 414         struct vlan_mc_entry    *mc;
 415         struct sockaddr_dl      sdl;
 416         int                     error;
 417
 418         /*VLAN_LOCK_ASSERT();*/
 419
 420         /* Find the parent. */
 421         sc = ifp->if_softc;
 422         ifp_p = PARENT(sc);
 423
 424         bzero((char *)&sdl, sizeof(sdl));
 425         sdl.sdl_len = sizeof(sdl);
 426         sdl.sdl_family = AF_LINK;
 427         sdl.sdl_index = ifp_p->if_index;
 428         sdl.sdl_type = IFT_ETHER;
 429         sdl.sdl_alen = ETHER_ADDR_LEN;
 430
 431         /* First, remove any existing filter entries. */
 432         while ((mc = SLIST_FIRST(&sc->vlan_mc_listhead)) != NULL) {
 433                 bcopy((char *)&mc->mc_addr, LLADDR(&sdl), ETHER_ADDR_LEN);
 434                 error = if_delmulti(ifp_p, (struct sockaddr *)&sdl);
 435                 if (error)
 436                         return (error);
 437                 SLIST_REMOVE_HEAD(&sc->vlan_mc_listhead, mc_entries);
 438                 free(mc, M_VLAN);
 439         }
 440
 441         /* Now program new ones. */
 442         TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
 443                 if (ifma->ifma_addr->sa_family != AF_LINK)
 444                         continue;
 445                 mc = malloc(sizeof(struct vlan_mc_entry), M_VLAN, M_NOWAIT);
 446                 if (mc == NULL)
 447                         return (ENOMEM);
 448                 bcopy(LLADDR((struct sockaddr_dl *)ifma->ifma_addr),
 449                     (char *)&mc->mc_addr, ETHER_ADDR_LEN);
 450                 SLIST_INSERT_HEAD(&sc->vlan_mc_listhead, mc, mc_entries);
 451                 bcopy(LLADDR((struct sockaddr_dl *)ifma->ifma_addr),
 452                     LLADDR(&sdl), ETHER_ADDR_LEN);
 453                 error = if_addmulti(ifp_p, (struct sockaddr *)&sdl, &rifma);
 454                 if (error)
 455                         return (error);
 456         }
 457
 458         return (0);
 459 }
 460
 461 /*
 462  * A handler for network interface departure events.
 463  * Track departure of trunks here so that we don't access invalid
 464  * pointers or whatever if a trunk is ripped from under us, e.g.,
 465  * by ejecting its hot-plug card.
 466  */
 467 static void
 468 vlan_ifdetach(void *arg __unused, struct ifnet *ifp)
 469 {
 470         struct ifvlan *ifv;
 471         int i;
 472
 473         /*
 474          * Check if it's a trunk interface first of all
 475          * to avoid needless locking.
 476          */
 477         if (ifp->if_vlantrunk == NULL)
 478                 return;
 479
 480         VLAN_LOCK();
 481         /*
 482          * OK, it's a trunk.  Loop over and detach all vlan's on it.
 483          * Check trunk pointer after each vlan_unconfig() as it will
 484          * free it and set to NULL after the last vlan was detached.
 485          */
 486 #ifdef VLAN_ARRAY
 487         for (i = 0; i < VLAN_ARRAY_SIZE; i++)
 488                 if ((ifv = ifp->if_vlantrunk->vlans[i])) {
 489                         vlan_unconfig_locked(ifv->ifv_ifp);
 490                         if (ifp->if_vlantrunk == NULL)
 491                                 break;
 492                 }
 493 #else /* VLAN_ARRAY */
 494 restart:
 495         for (i = 0; i < (1 << ifp->if_vlantrunk->hwidth); i++)
 496                 if ((ifv = LIST_FIRST(&ifp->if_vlantrunk->hash[i]))) {
 497                         vlan_unconfig_locked(ifv->ifv_ifp);
 498                         if (ifp->if_vlantrunk)
 499                                 goto restart;   /* trunk->hwidth can change */
 500                         else
 501                                 break;
 502                 }
 503 #endif /* VLAN_ARRAY */
 504         /* Trunk should have been destroyed in vlan_unconfig(). */
 505         KASSERT(ifp->if_vlantrunk == NULL, ("%s: purge failed", __func__));
 506         VLAN_UNLOCK();
 507 }
 508
 509 /*
 510  * VLAN support can be loaded as a module.  The only place in the
 511  * system that's intimately aware of this is ether_input.  We hook
 512  * into this code through vlan_input_p which is defined there and
 513  * set here.  Noone else in the system should be aware of this so
 514  * we use an explicit reference here.
 515  */
 516 extern  void (*vlan_input_p)(struct ifnet *, struct mbuf *);
 517
 518 /* For if_link_state_change() eyes only... */
 519 extern  void (*vlan_link_state_p)(struct ifnet *, int);
 520
 521 static int
 522 vlan_modevent(module_t mod, int type, void *data)
 523 {
 524
 525         switch (type) {
 526         case MOD_LOAD:
 527                 ifdetach_tag = EVENTHANDLER_REGISTER(ifnet_departure_event,
 528                     vlan_ifdetach, NULL, EVENTHANDLER_PRI_ANY);
 529                 if (ifdetach_tag == NULL)
 530                         return (ENOMEM);
 531                 VLAN_LOCK_INIT();
 532                 vlan_input_p = vlan_input;
 533                 vlan_link_state_p = vlan_link_state;
 534                 vlan_trunk_cap_p = vlan_trunk_capabilities;
 535                 if_clone_attach(&vlan_cloner);
 536                 if (bootverbose)
 537                         printf("vlan: initialized, using "
 538 #ifdef VLAN_ARRAY
 539                                "full-size arrays"
 540 #else
 541                                "hash tables with chaining"
 542 #endif
 543
 544                                "\n");
 545                 break;
 546         case MOD_UNLOAD:
 547                 if_clone_detach(&vlan_cloner);
 548                 EVENTHANDLER_DEREGISTER(ifnet_departure_event, ifdetach_tag);
 549                 vlan_input_p = NULL;
 550                 vlan_link_state_p = NULL;
 551                 vlan_trunk_cap_p = NULL;
 552                 VLAN_LOCK_DESTROY();
 553                 if (bootverbose)
 554                         printf("vlan: unloaded\n");
 555                 break;
 556         default:
 557                 return (EOPNOTSUPP);
 558         }
 559         return (0);
 560 }
 561
 562 static moduledata_t vlan_mod = {
 563         "if_vlan",
 564         vlan_modevent,
 565         0
 566 };
 567
 568 DECLARE_MODULE(if_vlan, vlan_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
 569 MODULE_VERSION(if_vlan, 3);
 570 MODULE_DEPEND(if_vlan, miibus, 1, 1, 1);
 571
 572 static struct ifnet *
 573 vlan_clone_match_ethertag(struct if_clone *ifc, const char *name, int *tag)
 574 {
 575         const char *cp;
 576         struct ifnet *ifp;
 577         int t = 0;
 578
 579         /* Check for <etherif>.<vlan> style interface names. */
 580         IFNET_RLOCK();
 581         TAILQ_FOREACH(ifp, &ifnet, if_link) {
 582                 if (ifp->if_type != IFT_ETHER)
 583                         continue;
 584                 if (strncmp(ifp->if_xname, name, strlen(ifp->if_xname)) != 0)
 585                         continue;
 586                 cp = name + strlen(ifp->if_xname);
 587                 if (*cp != '.')
 588                         continue;
 589                 for(; *cp != '\0'; cp++) {
 590                         if (*cp < '0' || *cp > '9')
 591                                 continue;
 592                         t = (t * 10) + (*cp - '0');
 593                 }
 594                 if (tag != NULL)
 595                         *tag = t;
 596                 break;
 597         }
 598         IFNET_RUNLOCK();
 599
 600         return (ifp);
 601 }
 602
 603 static int
 604 vlan_clone_match(struct if_clone *ifc, const char *name)
 605 {
 606         const char *cp;
 607
 608         if (vlan_clone_match_ethertag(ifc, name, NULL) != NULL)
 609                 return (1);
 610
 611         if (strncmp(VLANNAME, name, strlen(VLANNAME)) != 0)
 612                 return (0);
 613         for (cp = name + 4; *cp != '\0'; cp++) {
 614                 if (*cp < '0' || *cp > '9')
 615                         return (0);
 616         }
 617
 618         return (1);
 619 }
 620
 621 static int
 622 vlan_clone_create(struct if_clone *ifc, char *name, size_t len, caddr_t params)
 623 {
 624         char *dp;
 625         int wildcard;
 626         int unit;
 627         int error;
 628         int tag;
 629         int ethertag;
 630         struct ifvlan *ifv;
 631         struct ifnet *ifp;
 632         struct ifnet *p;
 633         struct vlanreq vlr;
 634         static const u_char eaddr[ETHER_ADDR_LEN];      /* 00:00:00:00:00:00 */
 635
 636         /*
 637          * There are 3 (ugh) ways to specify the cloned device:
 638          * o pass a parameter block with the clone request.
 639          * o specify parameters in the text of the clone device name
 640          * o specify no parameters and get an unattached device that
 641          *   must be configured separately.
 642          * The first technique is preferred; the latter two are
 643          * supported for backwards compatibilty.
 644          */
 645         if (params) {
 646                 error = copyin(params, &vlr, sizeof(vlr));
 647                 if (error)
 648                         return error;
 649                 p = ifunit(vlr.vlr_parent);
 650                 if (p == NULL)
 651                         return ENXIO;
 652                 /*
 653                  * Don't let the caller set up a VLAN tag with
 654                  * anything except VLID bits.
 655                  */
 656                 if (vlr.vlr_tag & ~EVL_VLID_MASK)
 657                         return (EINVAL);
 658                 error = ifc_name2unit(name, &unit);
 659                 if (error != 0)
 660                         return (error);
 661
 662                 ethertag = 1;
 663                 tag = vlr.vlr_tag;
 664                 wildcard = (unit < 0);
 665         } else if ((p = vlan_clone_match_ethertag(ifc, name, &tag)) != NULL) {
 666                 ethertag = 1;
 667                 unit = -1;
 668                 wildcard = 0;
 669
 670                 /*
 671                  * Don't let the caller set up a VLAN tag with
 672                  * anything except VLID bits.
 673                  */
 674                 if (tag & ~EVL_VLID_MASK)
 675                         return (EINVAL);
 676         } else {
 677                 ethertag = 0;
 678
 679                 error = ifc_name2unit(name, &unit);
 680                 if (error != 0)
 681                         return (error);
 682
 683                 wildcard = (unit < 0);
 684         }
 685
 686         error = ifc_alloc_unit(ifc, &unit);
 687         if (error != 0)
 688                 return (error);
 689
 690         /* In the wildcard case, we need to update the name. */
 691         if (wildcard) {
 692                 for (dp = name; *dp != '\0'; dp++);
 693                 if (snprintf(dp, len - (dp-name), "%d", unit) >
 694                     len - (dp-name) - 1) {
 695                         panic("%s: interface name too long", __func__);
 696                 }
 697         }
 698
 699         ifv = malloc(sizeof(struct ifvlan), M_VLAN, M_WAITOK | M_ZERO);
 700         ifp = ifv->ifv_ifp = if_alloc(IFT_ETHER);
 701         if (ifp == NULL) {
 702                 ifc_free_unit(ifc, unit);
 703                 free(ifv, M_VLAN);
 704                 return (ENOSPC);
 705         }
 706         SLIST_INIT(&ifv->vlan_mc_listhead);
 707
 708         ifp->if_softc = ifv;
 709         /*
 710          * Set the name manually rather than using if_initname because
 711          * we don't conform to the default naming convention for interfaces.
 712          */
 713         strlcpy(ifp->if_xname, name, IFNAMSIZ);
 714         ifp->if_dname = ifc->ifc_name;
 715         ifp->if_dunit = unit;
 716         /* NB: flags are not set here */
 717         ifp->if_linkmib = &ifv->ifv_mib;
 718         ifp->if_linkmiblen = sizeof(ifv->ifv_mib);
 719         /* NB: mtu is not set here */
 720
 721         ifp->if_init = vlan_init;
 722         ifp->if_start = vlan_start;
 723         ifp->if_ioctl = vlan_ioctl;
 724         ifp->if_snd.ifq_maxlen = ifqmaxlen;
 725         ifp->if_flags = VLAN_IFFLAGS;
 726         ether_ifattach(ifp, eaddr);
 727         /* Now undo some of the damage... */
 728         ifp->if_baudrate = 0;
 729         ifp->if_type = IFT_L2VLAN;
 730         ifp->if_hdrlen = ETHER_VLAN_ENCAP_LEN;
 731
 732         if (ethertag) {
 733                 error = vlan_config(ifv, p, tag);
 734                 if (error != 0) {
 735                         /*
 736                          * Since we've partialy failed, we need to back
 737                          * out all the way, otherwise userland could get
 738                          * confused.  Thus, we destroy the interface.
 739                          */
 740                         ether_ifdetach(ifp);
 741                         vlan_unconfig(ifp);
 742                         if_free_type(ifp, IFT_ETHER);
 743                         ifc_free_unit(ifc, unit);
 744                         free(ifv, M_VLAN);
 745
 746                         return (error);
 747                 }
 748
 749                 /* Update flags on the parent, if necessary. */
 750                 vlan_setflags(ifp, 1);
 751         }
 752
 753         return (0);
 754 }
 755
 756 static int
 757 vlan_clone_destroy(struct if_clone *ifc, struct ifnet *ifp)
 758 {
 759         struct ifvlan *ifv = ifp->if_softc;
 760         int unit = ifp->if_dunit;
 761
 762         ether_ifdetach(ifp);    /* first, remove it from system-wide lists */
 763         vlan_unconfig(ifp);     /* now it can be unconfigured and freed */
 764         if_free_type(ifp, IFT_ETHER);
 765         free(ifv, M_VLAN);
 766         ifc_free_unit(ifc, unit);
 767
 768         return (0);
 769 }
 770
 771 /*
 772  * The ifp->if_init entry point for vlan(4) is a no-op.
 773  */
 774 static void
 775 vlan_init(void *foo __unused)
 776 {
 777 }
 778
 779 /*
 780  * The if_start method for vlan(4) interface. It doesn't
 781  * raises the IFF_DRV_OACTIVE flag, since it is called
 782  * only from IFQ_HANDOFF() macro in ether_output_frame().
 783  * If the interface queue is full, and vlan_start() is
 784  * not called, the queue would never get emptied and
 785  * interface would stall forever.
 786  */
 787 static void
 788 vlan_start(struct ifnet *ifp)
 789 {
 790         struct ifvlan *ifv;
 791         struct ifnet *p;
 792         struct mbuf *m;
 793         int error;
 794
 795         ifv = ifp->if_softc;
 796         p = PARENT(ifv);
 797
 798         for (;;) {
 799                 IF_DEQUEUE(&ifp->if_snd, m);
 800                 if (m == NULL)
 801                         break;
 802                 BPF_MTAP(ifp, m);
 803
 804                 /*
 805                  * Do not run parent's if_start() if the parent is not up,
 806                  * or parent's driver will cause a system crash.
 807                  */
 808                 if (!UP_AND_RUNNING(p)) {
 809                         m_freem(m);
 810                         ifp->if_collisions++;
 811                         continue;
 812                 }
 813
 814                 /*
 815                  * Pad the frame to the minimum size allowed if told to.
 816                  * This option is in accord with IEEE Std 802.1Q, 2003 Ed.,
 817                  * paragraph C.4.4.3.b.  It can help to work around buggy
 818                  * bridges that violate paragraph C.4.4.3.a from the same
 819                  * document, i.e., fail to pad short frames after untagging.
 820                  * E.g., a tagged frame 66 bytes long (incl. FCS) is OK, but
 821                  * untagging it will produce a 62-byte frame, which is a runt
 822                  * and requires padding.  There are VLAN-enabled network
 823                  * devices that just discard such runts instead or mishandle
 824                  * them somehow.
 825                  */
 826                 if (soft_pad) {
 827                         static char pad[8];     /* just zeros */
 828                         int n;
 829
 830                         for (n = ETHERMIN + ETHER_HDR_LEN - m->m_pkthdr.len;
 831                              n > 0; n -= sizeof(pad))
 832                                 if (!m_append(m, min(n, sizeof(pad)), pad))
 833                                         break;
 834
 835                         if (n > 0) {
 836                                 if_printf(ifp, "cannot pad short frame\n");
 837                                 ifp->if_oerrors++;
 838                                 m_freem(m);
 839                                 continue;
 840                         }
 841                 }
 842
 843                 /*
 844                  * If underlying interface can do VLAN tag insertion itself,
 845                  * just pass the packet along. However, we need some way to
 846                  * tell the interface where the packet came from so that it
 847                  * knows how to find the VLAN tag to use, so we attach a
 848                  * packet tag that holds it.
 849                  */
 850                 if (p->if_capenable & IFCAP_VLAN_HWTAGGING) {
 851                         m->m_pkthdr.ether_vtag = ifv->ifv_tag;
 852                         m->m_flags |= M_VLANTAG;
 853                 } else {
 854                         m = ether_vlanencap(m, ifv->ifv_tag);
 855                         if (m == NULL) {
 856                                 if_printf(ifp,
 857                                     "unable to prepend VLAN header\n");
 858                                 ifp->if_oerrors++;
 859                                 continue;
 860                         }
 861                 }
 862
 863                 /*
 864                  * Send it, precisely as ether_output() would have.
 865                  * We are already running at splimp.
 866                  */
 867                 IFQ_HANDOFF(p, m, error);
 868                 if (!error)
 869                         ifp->if_opackets++;
 870                 else
 871                         ifp->if_oerrors++;
 872         }
 873 }
 874
 875 static void
 876 vlan_input(struct ifnet *ifp, struct mbuf *m)
 877 {
 878         struct ifvlantrunk *trunk = ifp->if_vlantrunk;
 879         struct ifvlan *ifv;
 880         uint16_t tag;
 881
 882         KASSERT(trunk != NULL, ("%s: no trunk", __func__));
 883
 884         if (m->m_flags & M_VLANTAG) {
 885                 /*
 886                  * Packet is tagged, but m contains a normal
 887                  * Ethernet frame; the tag is stored out-of-band.
 888                  */
 889                 tag = EVL_VLANOFTAG(m->m_pkthdr.ether_vtag);
 890                 m->m_flags &= ~M_VLANTAG;
 891         } else {
 892                 struct ether_vlan_header *evl;
 893
 894                 /*
 895                  * Packet is tagged in-band as specified by 802.1q.
 896                  */
 897                 switch (ifp->if_type) {
 898                 case IFT_ETHER:
 899                         if (m->m_len < sizeof(*evl) &&
 900                             (m = m_pullup(m, sizeof(*evl))) == NULL) {
 901                                 if_printf(ifp, "cannot pullup VLAN header\n");
 902                                 return;
 903                         }
 904                         evl = mtod(m, struct ether_vlan_header *);
 905                         tag = EVL_VLANOFTAG(ntohs(evl->evl_tag));
 906
 907                         /*
 908                          * Remove the 802.1q header by copying the Ethernet
 909                          * addresses over it and adjusting the beginning of
 910                          * the data in the mbuf.  The encapsulated Ethernet
 911                          * type field is already in place.
 912                          */
 913                         bcopy((char *)evl, (char *)evl + ETHER_VLAN_ENCAP_LEN,
 914                               ETHER_HDR_LEN - ETHER_TYPE_LEN);
 915                         m_adj(m, ETHER_VLAN_ENCAP_LEN);
 916                         break;
 917
 918                 default:
 919 #ifdef INVARIANTS
 920                         panic("%s: %s has unsupported if_type %u",
 921                               __func__, ifp->if_xname, ifp->if_type);
 922 #endif
 923                         m_freem(m);
 924                         ifp->if_noproto++;
 925                         return;
 926                 }
 927         }
 928
 929         TRUNK_RLOCK(trunk);
 930 #ifdef VLAN_ARRAY
 931         ifv = trunk->vlans[tag];
 932 #else
 933         ifv = vlan_gethash(trunk, tag);
 934 #endif
 935         if (ifv == NULL || !UP_AND_RUNNING(ifv->ifv_ifp)) {
 936                 TRUNK_RUNLOCK(trunk);
 937                 m_freem(m);
 938                 ifp->if_noproto++;
 939                 return;
 940         }
 941         TRUNK_RUNLOCK(trunk);
 942
 943         m->m_pkthdr.rcvif = ifv->ifv_ifp;
 944         ifv->ifv_ifp->if_ipackets++;
 945
 946         /* Pass it back through the parent's input routine. */
 947         (*ifp->if_input)(ifv->ifv_ifp, m);
 948 }
 949
 950 static int
 951 vlan_config(struct ifvlan *ifv, struct ifnet *p, uint16_t tag)
 952 {
 953         struct ifvlantrunk *trunk;
 954         struct ifnet *ifp;
 955         int error = 0;
 956
 957         /* VID numbers 0x0 and 0xFFF are reserved */
 958         if (tag == 0 || tag == 0xFFF)
 959                 return (EINVAL);
 960         if (p->if_type != IFT_ETHER)
 961                 return (EPROTONOSUPPORT);
 962         if ((p->if_flags & VLAN_IFFLAGS) != VLAN_IFFLAGS)
 963                 return (EPROTONOSUPPORT);
 964         if (ifv->ifv_trunk)
 965                 return (EBUSY);
 966
 967         if (p->if_vlantrunk == NULL) {
 968                 trunk = malloc(sizeof(struct ifvlantrunk),
 969                     M_VLAN, M_WAITOK | M_ZERO);
 970 #ifndef VLAN_ARRAY
 971                 vlan_inithash(trunk);
 972 #endif
 973                 VLAN_LOCK();
 974                 if (p->if_vlantrunk != NULL) {
 975                         /* A race that that is very unlikely to be hit. */
 976 #ifndef VLAN_ARRAY
 977                         vlan_freehash(trunk);
 978 #endif
 979                         free(trunk, M_VLAN);
 980                         goto exists;
 981                 }
 982                 TRUNK_LOCK_INIT(trunk);
 983                 TRUNK_LOCK(trunk);
 984                 p->if_vlantrunk = trunk;
 985                 trunk->parent = p;
 986         } else {
 987                 VLAN_LOCK();
 988 exists:
 989                 trunk = p->if_vlantrunk;
 990                 TRUNK_LOCK(trunk);
 991         }
 992
 993         ifv->ifv_tag = tag;     /* must set this before vlan_inshash() */
 994 #ifdef VLAN_ARRAY
 995         if (trunk->vlans[tag] != NULL) {
 996                 error = EEXIST;
 997                 goto done;
 998         }
 999         trunk->vlans[tag] = ifv;
1000         trunk->refcnt++;
1001 #else
1002         error = vlan_inshash(trunk, ifv);
1003         if (error)
1004                 goto done;
1005 #endif
1006         ifv->ifv_proto = ETHERTYPE_VLAN;
1007         ifv->ifv_encaplen = ETHER_VLAN_ENCAP_LEN;
1008         ifv->ifv_mintu = ETHERMIN;
1009         ifv->ifv_pflags = 0;
1010
1011         /*
1012          * If the parent supports the VLAN_MTU capability,
1013          * i.e. can Tx/Rx larger than ETHER_MAX_LEN frames,
1014          * use it.
1015          */
1016         if (p->if_capenable & IFCAP_VLAN_MTU) {
1017                 /*
1018                  * No need to fudge the MTU since the parent can
1019                  * handle extended frames.
1020                  */
1021                 ifv->ifv_mtufudge = 0;
1022         } else {
1023                 /*
1024                  * Fudge the MTU by the encapsulation size.  This
1025                  * makes us incompatible with strictly compliant
1026                  * 802.1Q implementations, but allows us to use
1027                  * the feature with other NetBSD implementations,
1028                  * which might still be useful.
1029                  */
1030                 ifv->ifv_mtufudge = ifv->ifv_encaplen;
1031         }
1032
1033         ifv->ifv_trunk = trunk;
1034         ifp = ifv->ifv_ifp;
1035         ifp->if_mtu = p->if_mtu - ifv->ifv_mtufudge;
1036         ifp->if_baudrate = p->if_baudrate;
1037         /*
1038          * Copy only a selected subset of flags from the parent.
1039          * Other flags are none of our business.
1040          */
1041 #define VLAN_COPY_FLAGS (IFF_SIMPLEX)
1042         ifp->if_flags &= ~VLAN_COPY_FLAGS;
1043         ifp->if_flags |= p->if_flags & VLAN_COPY_FLAGS;
1044 #undef VLAN_COPY_FLAGS
1045
1046         ifp->if_link_state = p->if_link_state;
1047
1048         vlan_capabilities(ifv);
1049
1050         /*
1051          * Set up our ``Ethernet address'' to reflect the underlying
1052          * physical interface's.
1053          */
1054         bcopy(IF_LLADDR(p), IF_LLADDR(ifp), ETHER_ADDR_LEN);
1055
1056         /*
1057          * Configure multicast addresses that may already be
1058          * joined on the vlan device.
1059          */
1060         (void)vlan_setmulti(ifp); /* XXX: VLAN lock held */
1061
1062         /* We are ready for operation now. */
1063         ifp->if_drv_flags |= IFF_DRV_RUNNING;
1064 done:
1065         TRUNK_UNLOCK(trunk);
1066         if (error == 0)
1067                 EVENTHANDLER_INVOKE(vlan_config, p, ifv->ifv_tag);
1068         VLAN_UNLOCK();
1069
1070         return (error);
1071 }
1072
1073 static int
1074 vlan_unconfig(struct ifnet *ifp)
1075 {
1076         int ret;
1077
1078         VLAN_LOCK();
1079         ret = vlan_unconfig_locked(ifp);
1080         VLAN_UNLOCK();
1081         return (ret);
1082 }
1083
1084 static int
1085 vlan_unconfig_locked(struct ifnet *ifp)
1086 {
1087         struct ifvlantrunk *trunk;
1088         struct vlan_mc_entry *mc;
1089         struct ifvlan *ifv;
1090         struct ifnet  *parent;
1091         int error;
1092
1093         VLAN_LOCK_ASSERT();
1094
1095         ifv = ifp->if_softc;
1096         trunk = ifv->ifv_trunk;
1097         parent = NULL;
1098
1099         if (trunk != NULL) {
1100                 struct sockaddr_dl sdl;
1101
1102                 TRUNK_LOCK(trunk);
1103                 parent = trunk->parent;
1104
1105                 /*
1106                  * Since the interface is being unconfigured, we need to
1107                  * empty the list of multicast groups that we may have joined
1108                  * while we were alive from the parent's list.
1109                  */
1110                 bzero((char *)&sdl, sizeof(sdl));
1111                 sdl.sdl_len = sizeof(sdl);
1112                 sdl.sdl_family = AF_LINK;
1113                 sdl.sdl_index = parent->if_index;
1114                 sdl.sdl_type = IFT_ETHER;
1115                 sdl.sdl_alen = ETHER_ADDR_LEN;
1116
1117                 while ((mc = SLIST_FIRST(&ifv->vlan_mc_listhead)) != NULL) {
1118                         bcopy((char *)&mc->mc_addr, LLADDR(&sdl),
1119                             ETHER_ADDR_LEN);
1120                         error = if_delmulti(parent, (struct sockaddr *)&sdl);
1121                         if (error)
1122                                 return (error);
1123                         SLIST_REMOVE_HEAD(&ifv->vlan_mc_listhead, mc_entries);
1124                         free(mc, M_VLAN);
1125                 }
1126
1127                 vlan_setflags(ifp, 0); /* clear special flags on parent */
1128 #ifdef VLAN_ARRAY
1129                 trunk->vlans[ifv->ifv_tag] = NULL;
1130                 trunk->refcnt--;
1131 #else
1132                 vlan_remhash(trunk, ifv);
1133 #endif
1134                 ifv->ifv_trunk = NULL;
1135
1136                 /*
1137                  * Check if we were the last.
1138                  */
1139                 if (trunk->refcnt == 0) {
1140                         trunk->parent->if_vlantrunk = NULL;
1141                         /*
1142                          * XXXGL: If some ithread has already entered
1143                          * vlan_input() and is now blocked on the trunk
1144                          * lock, then it should preempt us right after
1145                          * unlock and finish its work. Then we will acquire
1146                          * lock again in trunk_destroy().
1147                          */
1148                         TRUNK_UNLOCK(trunk);
1149                         trunk_destroy(trunk);
1150                 } else
1151                         TRUNK_UNLOCK(trunk);
1152         }
1153
1154         /* Disconnect from parent. */
1155         if (ifv->ifv_pflags)
1156                 if_printf(ifp, "%s: ifv_pflags unclean\n", __func__);
1157         ifp->if_mtu = ETHERMTU;
1158         ifp->if_link_state = LINK_STATE_UNKNOWN;
1159         ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
1160
1161         /*
1162          * Only dispatch an event if vlan was
1163          * attached, otherwise there is nothing
1164          * to cleanup anyway.
1165          */
1166         if (parent != NULL)
1167                 EVENTHANDLER_INVOKE(vlan_unconfig, parent, ifv->ifv_tag);
1168
1169         return (0);
1170 }
1171
1172 /* Handle a reference counted flag that should be set on the parent as well */
1173 static int
1174 vlan_setflag(struct ifnet *ifp, int flag, int status,
1175              int (*func)(struct ifnet *, int))
1176 {
1177         struct ifvlan *ifv;
1178         int error;
1179
1180         /* XXX VLAN_LOCK_ASSERT(); */
1181
1182         ifv = ifp->if_softc;
1183         status = status ? (ifp->if_flags & flag) : 0;
1184         /* Now "status" contains the flag value or 0 */
1185
1186         /*
1187          * See if recorded parent's status is different from what
1188          * we want it to be.  If it is, flip it.  We record parent's
1189          * status in ifv_pflags so that we won't clear parent's flag
1190          * we haven't set.  In fact, we don't clear or set parent's
1191          * flags directly, but get or release references to them.
1192          * That's why we can be sure that recorded flags still are
1193          * in accord with actual parent's flags.
1194          */
1195         if (status != (ifv->ifv_pflags & flag)) {
1196                 error = (*func)(PARENT(ifv), status);
1197                 if (error)
1198                         return (error);
1199                 ifv->ifv_pflags &= ~flag;
1200                 ifv->ifv_pflags |= status;
1201         }
1202         return (0);
1203 }
1204
1205 /*
1206  * Handle IFF_* flags that require certain changes on the parent:
1207  * if "status" is true, update parent's flags respective to our if_flags;
1208  * if "status" is false, forcedly clear the flags set on parent.
1209  */
1210 static int
1211 vlan_setflags(struct ifnet *ifp, int status)
1212 {
1213         int error, i;
1214
1215         for (i = 0; vlan_pflags[i].flag; i++) {
1216                 error = vlan_setflag(ifp, vlan_pflags[i].flag,
1217                                      status, vlan_pflags[i].func);
1218                 if (error)
1219                         return (error);
1220         }
1221         return (0);
1222 }
1223
1224 /* Inform all vlans that their parent has changed link state */
1225 static void
1226 vlan_link_state(struct ifnet *ifp, int link)
1227 {
1228         struct ifvlantrunk *trunk = ifp->if_vlantrunk;
1229         struct ifvlan *ifv;
1230         int i;
1231
1232         TRUNK_LOCK(trunk);
1233 #ifdef VLAN_ARRAY
1234         for (i = 0; i < VLAN_ARRAY_SIZE; i++)
1235                 if (trunk->vlans[i] != NULL) {
1236                         ifv = trunk->vlans[i];
1237 #else
1238         for (i = 0; i < (1 << trunk->hwidth); i++)
1239                 LIST_FOREACH(ifv, &trunk->hash[i], ifv_list) {
1240 #endif
1241                         ifv->ifv_ifp->if_baudrate = trunk->parent->if_baudrate;
1242                         if_link_state_change(ifv->ifv_ifp,
1243                             trunk->parent->if_link_state);
1244                 }
1245         TRUNK_UNLOCK(trunk);
1246 }
1247
1248 static void
1249 vlan_capabilities(struct ifvlan *ifv)
1250 {
1251         struct ifnet *p = PARENT(ifv);
1252         struct ifnet *ifp = ifv->ifv_ifp;
1253
1254         TRUNK_LOCK_ASSERT(TRUNK(ifv));
1255
1256         /*
1257          * If the parent interface can do checksum offloading
1258          * on VLANs, then propagate its hardware-assisted
1259          * checksumming flags. Also assert that checksum
1260          * offloading requires hardware VLAN tagging.
1261          */
1262         if (p->if_capabilities & IFCAP_VLAN_HWCSUM)
1263                 ifp->if_capabilities = p->if_capabilities & IFCAP_HWCSUM;
1264
1265         if (p->if_capenable & IFCAP_VLAN_HWCSUM &&
1266             p->if_capenable & IFCAP_VLAN_HWTAGGING) {
1267                 ifp->if_capenable = p->if_capenable & IFCAP_HWCSUM;
1268                 ifp->if_hwassist = p->if_hwassist;
1269         } else {
1270                 ifp->if_capenable = 0;
1271                 ifp->if_hwassist = 0;
1272         }
1273 }
1274
1275 static void
1276 vlan_trunk_capabilities(struct ifnet *ifp)
1277 {
1278         struct ifvlantrunk *trunk = ifp->if_vlantrunk;
1279         struct ifvlan *ifv;
1280         int i;
1281
1282         TRUNK_LOCK(trunk);
1283 #ifdef VLAN_ARRAY
1284         for (i = 0; i < VLAN_ARRAY_SIZE; i++)
1285                 if (trunk->vlans[i] != NULL) {
1286                         ifv = trunk->vlans[i];
1287 #else
1288         for (i = 0; i < (1 << trunk->hwidth); i++) {
1289                 LIST_FOREACH(ifv, &trunk->hash[i], ifv_list)
1290 #endif
1291                         vlan_capabilities(ifv);
1292         }
1293         TRUNK_UNLOCK(trunk);
1294 }
1295
1296 static int
1297 vlan_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
1298 {
1299         struct ifnet *p;
1300         struct ifreq *ifr;
1301         struct ifvlan *ifv;
1302         struct vlanreq vlr;
1303         int error = 0;
1304
1305         ifr = (struct ifreq *)data;
1306         ifv = ifp->if_softc;
1307
1308         switch (cmd) {
1309         case SIOCGIFMEDIA:
1310                 VLAN_LOCK();
1311                 if (TRUNK(ifv) != NULL) {
1312                         error = (*PARENT(ifv)->if_ioctl)(PARENT(ifv),
1313                                         SIOCGIFMEDIA, data);
1314                         VLAN_UNLOCK();
1315                         /* Limit the result to the parent's current config. */
1316                         if (error == 0) {
1317                                 struct ifmediareq *ifmr;
1318
1319                                 ifmr = (struct ifmediareq *)data;
1320                                 if (ifmr->ifm_count >= 1 && ifmr->ifm_ulist) {
1321                                         ifmr->ifm_count = 1;
1322                                         error = copyout(&ifmr->ifm_current,
1323                                                 ifmr->ifm_ulist,
1324                                                 sizeof(int));
1325                                 }
1326                         }
1327                 } else {
1328                         VLAN_UNLOCK();
1329                         error = EINVAL;
1330                 }
1331                 break;
1332
1333         case SIOCSIFMEDIA:
1334                 error = EINVAL;
1335                 break;
1336
1337         case SIOCSIFMTU:
1338                 /*
1339                  * Set the interface MTU.
1340                  */
1341                 VLAN_LOCK();
1342                 if (TRUNK(ifv) != NULL) {
1343                         if (ifr->ifr_mtu >
1344                              (PARENT(ifv)->if_mtu - ifv->ifv_mtufudge) ||
1345                             ifr->ifr_mtu <
1346                              (ifv->ifv_mintu - ifv->ifv_mtufudge))
1347                                 error = EINVAL;
1348                         else
1349                                 ifp->if_mtu = ifr->ifr_mtu;
1350                 } else
1351                         error = EINVAL;
1352                 VLAN_UNLOCK();
1353                 break;
1354
1355         case SIOCSETVLAN:
1356                 error = copyin(ifr->ifr_data, &vlr, sizeof(vlr));
1357                 if (error)
1358                         break;
1359                 if (vlr.vlr_parent[0] == '\0') {
1360                         vlan_unconfig(ifp);
1361                         break;
1362                 }
1363                 p = ifunit(vlr.vlr_parent);
1364                 if (p == 0) {
1365                         error = ENOENT;
1366                         break;
1367                 }
1368                 /*
1369                  * Don't let the caller set up a VLAN tag with
1370                  * anything except VLID bits.
1371                  */
1372                 if (vlr.vlr_tag & ~EVL_VLID_MASK) {
1373                         error = EINVAL;
1374                         break;
1375                 }
1376                 error = vlan_config(ifv, p, vlr.vlr_tag);
1377                 if (error)
1378                         break;
1379
1380                 /* Update flags on the parent, if necessary. */
1381                 vlan_setflags(ifp, 1);
1382                 break;
1383
1384         case SIOCGETVLAN:
1385                 bzero(&vlr, sizeof(vlr));
1386                 VLAN_LOCK();
1387                 if (TRUNK(ifv) != NULL) {
1388                         strlcpy(vlr.vlr_parent, PARENT(ifv)->if_xname,
1389                             sizeof(vlr.vlr_parent));
1390                         vlr.vlr_tag = ifv->ifv_tag;
1391                 }
1392                 VLAN_UNLOCK();
1393                 error = copyout(&vlr, ifr->ifr_data, sizeof(vlr));
1394                 break;
1395
1396         case SIOCSIFFLAGS:
1397                 /*
1398                  * We should propagate selected flags to the parent,
1399                  * e.g., promiscuous mode.
1400                  */
1401                 if (TRUNK(ifv) != NULL)
1402                         error = vlan_setflags(ifp, 1);
1403                 break;
1404
1405         case SIOCADDMULTI:
1406         case SIOCDELMULTI:
1407                 /*
1408                  * If we don't have a parent, just remember the membership for
1409                  * when we do.
1410                  */
1411                 if (TRUNK(ifv) != NULL)
1412                         error = vlan_setmulti(ifp);
1413                 break;
1414
1415         default:
1416                 error = ether_ioctl(ifp, cmd, data);
1417         }
1418
1419         return (error);
1420 }