sys/netgraph/ng_fec.c

   1 /*
   2  * ng_fec.c
   3  */
   4
   5 /*-
   6  * Copyright (c) 2001 Berkeley Software Design, Inc.
   7  * Copyright (c) 2000, 2001
   8  *      Bill Paul <wpaul@osd.bsdi.com>.  All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by Bill Paul.
  21  * 4. Neither the name of the author nor the names of any co-contributors
  22  *    may be used to endorse or promote products derived from this software
  23  *    without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  29  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  35  * THE POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * $FreeBSD$
  38  */
  39 /*-
  40  * Copyright (c) 1996-1999 Whistle Communications, Inc.
  41  * All rights reserved.
  42  *
  43  * Subject to the following obligations and disclaimer of warranty, use and
  44  * redistribution of this software, in source or object code forms, with or
  45  * without modifications are expressly permitted by Whistle Communications;
  46  * provided, however, that:
  47  * 1. Any and all reproductions of the source or object code must include the
  48  *    copyright notice above and the following disclaimer of warranties; and
  49  * 2. No rights are granted, in any manner or form, to use Whistle
  50  *    Communications, Inc. trademarks, including the mark "WHISTLE
  51  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  52  *    such appears in the above copyright notice or in the software.
  53  *
  54  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  55  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  56  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  57  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  58  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  59  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  60  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  61  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  62  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  63  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  64  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  65  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  66  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  67  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  68  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  69  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  70  * OF SUCH DAMAGE.
  71  *
  72  * Author: Archie Cobbs <archie@freebsd.org>
  73  *
  74  * $Whistle: ng_fec.c,v 1.33 1999/11/01 09:24:51 julian Exp $
  75  */
  76
  77 /*
  78  * This module implements ethernet channel bonding using the Cisco
  79  * Fast EtherChannel mechanism. Two or four ports may be combined
  80  * into a single aggregate interface.
  81  *
  82  * Interfaces are named fec0, fec1, etc.  New nodes take the
  83  * first available interface name.
  84  *
  85  * This node also includes Berkeley packet filter support.
  86  *
  87  * Note that this node doesn't need to connect to any other
  88  * netgraph nodes in order to do its work.
  89  */
  90
  91 #include <sys/param.h>
  92 #include <sys/systm.h>
  93 #include <sys/errno.h>
  94 #include <sys/kernel.h>
  95 #include <sys/malloc.h>
  96 #include <sys/mbuf.h>
  97 #include <sys/errno.h>
  98 #include <sys/sockio.h>
  99 #include <sys/socket.h>
 100 #include <sys/syslog.h>
 101 #include <sys/libkern.h>
 102 #include <sys/queue.h>
 103
 104 #include <net/if.h>
 105 #include <net/if_dl.h>
 106 #include <net/if_types.h>
 107 #include <net/if_media.h>
 108 #include <net/bpf.h>
 109 #include <net/ethernet.h>
 110
 111 #include "opt_inet.h"
 112 #include "opt_inet6.h"
 113
 114 #include <netinet/in.h>
 115 #ifdef INET
 116 #include <netinet/in_systm.h>
 117 #include <netinet/ip.h>
 118 #endif
 119
 120 #ifdef INET6
 121 #include <netinet/ip6.h>
 122 #endif
 123
 124 #include <netgraph/ng_message.h>
 125 #include <netgraph/netgraph.h>
 126 #include <netgraph/ng_parse.h>
 127 #include <netgraph/ng_fec.h>
 128
 129 /*
 130  * We need a way to stash a pointer to our netgraph node in the
 131  * ifnet structure so that receive handling works. As far as I can
 132  * tell, although there is an AF_NETGRAPH address family, it's only
 133  * used to identify sockaddr_ng structures: there is no netgraph address
 134  * family domain. This means the AF_NETGRAPH entry in ifp->if_afdata
 135  * should be unused, so we can use to hold our node context.
 136  */
 137 #define IFP2NG(ifp)     ((ifp)->if_afdata[AF_NETGRAPH])
 138
 139 /*
 140  * Current fast etherchannel implementations use either 2 or 4
 141  * ports, so for now we limit the maximum bundle size to 4 interfaces.
 142  */
 143 #define FEC_BUNDLESIZ   4
 144
 145 struct ng_fec_portlist {
 146         struct ifnet            *fec_if;
 147         void                    (*fec_if_input) (struct ifnet *,
 148                                                  struct mbuf *);
 149         int                     fec_idx;
 150         int                     fec_ifstat;
 151         struct ether_addr       fec_mac;
 152         TAILQ_ENTRY(ng_fec_portlist) fec_list;
 153 };
 154
 155 struct ng_fec_bundle {
 156         TAILQ_HEAD(,ng_fec_portlist) ng_fec_ports;
 157         int                     fec_ifcnt;
 158         int                     fec_btype;
 159         int                     (*fec_if_output) (struct ifnet *,
 160                                                   struct mbuf *,
 161                                                   struct sockaddr *,
 162                                                   struct rtentry *);
 163 };
 164
 165 #define FEC_BTYPE_MAC           0x01
 166 #define FEC_BTYPE_INET          0x02
 167 #define FEC_BTYPE_INET6         0x03
 168
 169 /* Node private data */
 170 struct ng_fec_private {
 171         struct ifnet *ifp;
 172         struct ifmedia ifmedia;
 173         int     if_flags;
 174         int     if_error;               /* XXX */
 175         int     unit;                   /* Interface unit number */
 176         node_p  node;                   /* Our netgraph node */
 177         struct ng_fec_bundle fec_bundle;/* Aggregate bundle */
 178         struct callout_handle fec_ch;   /* callout handle for ticker */
 179 };
 180 typedef struct ng_fec_private *priv_p;
 181
 182 /* Interface methods */
 183 static void     ng_fec_input(struct ifnet *, struct mbuf *);
 184 static void     ng_fec_start(struct ifnet *ifp);
 185 static int      ng_fec_choose_port(struct ng_fec_bundle *b,
 186                         struct mbuf *m, struct ifnet **ifp);
 187 static int      ng_fec_setport(struct ifnet *ifp, u_long cmd, caddr_t data);
 188 static void     ng_fec_init(void *arg);
 189 static void     ng_fec_stop(struct ifnet *ifp);
 190 static int      ng_fec_ifmedia_upd(struct ifnet *ifp);
 191 static void     ng_fec_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr);
 192 static int      ng_fec_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data);
 193 static int      ng_fec_output(struct ifnet *ifp, struct mbuf *m0,
 194                         struct sockaddr *dst, struct rtentry *rt0);
 195 static void     ng_fec_tick(void *arg);
 196 static int      ng_fec_addport(struct ng_fec_private *priv, char *iface);
 197 static int      ng_fec_delport(struct ng_fec_private *priv, char *iface);
 198
 199 #ifdef DEBUG
 200 static void     ng_fec_print_ioctl(struct ifnet *ifp, int cmd, caddr_t data);
 201 #endif
 202
 203 /* Netgraph methods */
 204 static int              ng_fec_mod_event(module_t, int, void *);
 205 static ng_constructor_t ng_fec_constructor;
 206 static ng_rcvmsg_t      ng_fec_rcvmsg;
 207 static ng_shutdown_t    ng_fec_shutdown;
 208
 209 /* List of commands and how to convert arguments to/from ASCII */
 210 static const struct ng_cmdlist ng_fec_cmds[] = {
 211         {
 212           NGM_FEC_COOKIE,
 213           NGM_FEC_ADD_IFACE,
 214           "add_iface",
 215           &ng_parse_string_type,
 216           NULL,
 217         },
 218         {
 219           NGM_FEC_COOKIE,
 220           NGM_FEC_DEL_IFACE,
 221           "del_iface",
 222           &ng_parse_string_type,
 223           NULL,
 224         },
 225         {
 226           NGM_FEC_COOKIE,
 227           NGM_FEC_SET_MODE_MAC,
 228           "set_mode_mac",
 229           NULL,
 230           NULL,
 231         },
 232         {
 233           NGM_FEC_COOKIE,
 234           NGM_FEC_SET_MODE_INET,
 235           "set_mode_inet",
 236           NULL,
 237           NULL,
 238         },
 239         { 0 }
 240 };
 241
 242 /* Node type descriptor */
 243 static struct ng_type typestruct = {
 244         .version =      NG_ABI_VERSION,
 245         .name =         NG_FEC_NODE_TYPE,
 246         .mod_event =    ng_fec_mod_event,
 247         .constructor =  ng_fec_constructor,
 248         .rcvmsg =       ng_fec_rcvmsg,
 249         .shutdown =     ng_fec_shutdown,
 250         .cmdlist =      ng_fec_cmds,
 251 };
 252 NETGRAPH_INIT(fec, &typestruct);
 253
 254 /* We keep a bitmap indicating which unit numbers are free.
 255    One means the unit number is free, zero means it's taken. */
 256 static int      *ng_fec_units = NULL;
 257 static int      ng_fec_units_len = 0;
 258 static int      ng_units_in_use = 0;
 259
 260 #define UNITS_BITSPERWORD       (sizeof(*ng_fec_units) * NBBY)
 261
 262 static struct mtx       ng_fec_mtx;
 263
 264 /*
 265  * Find the first free unit number for a new interface.
 266  * Increase the size of the unit bitmap as necessary.
 267  */
 268 static __inline int
 269 ng_fec_get_unit(int *unit)
 270 {
 271         int index, bit;
 272
 273         mtx_lock(&ng_fec_mtx);
 274         for (index = 0; index < ng_fec_units_len
 275             && ng_fec_units[index] == 0; index++);
 276         if (index == ng_fec_units_len) {                /* extend array */
 277                 int i, *newarray, newlen;
 278
 279                 newlen = (2 * ng_fec_units_len) + 4;
 280                 MALLOC(newarray, int *, newlen * sizeof(*ng_fec_units),
 281                     M_NETGRAPH, M_NOWAIT);
 282                 if (newarray == NULL) {
 283                         mtx_unlock(&ng_fec_mtx);
 284                         return (ENOMEM);
 285                 }
 286                 bcopy(ng_fec_units, newarray,
 287                     ng_fec_units_len * sizeof(*ng_fec_units));
 288                 for (i = ng_fec_units_len; i < newlen; i++)
 289                         newarray[i] = ~0;
 290                 if (ng_fec_units != NULL)
 291                         FREE(ng_fec_units, M_NETGRAPH);
 292                 ng_fec_units = newarray;
 293                 ng_fec_units_len = newlen;
 294         }
 295         bit = ffs(ng_fec_units[index]) - 1;
 296         KASSERT(bit >= 0 && bit <= UNITS_BITSPERWORD - 1,
 297             ("%s: word=%d bit=%d", __func__, ng_fec_units[index], bit));
 298         ng_fec_units[index] &= ~(1 << bit);
 299         *unit = (index * UNITS_BITSPERWORD) + bit;
 300         ng_units_in_use++;
 301         mtx_unlock(&ng_fec_mtx);
 302         return (0);
 303 }
 304
 305 /*
 306  * Free a no longer needed unit number.
 307  */
 308 static __inline void
 309 ng_fec_free_unit(int unit)
 310 {
 311         int index, bit;
 312
 313         index = unit / UNITS_BITSPERWORD;
 314         bit = unit % UNITS_BITSPERWORD;
 315         mtx_lock(&ng_fec_mtx);
 316         KASSERT(index < ng_fec_units_len,
 317             ("%s: unit=%d len=%d", __func__, unit, ng_fec_units_len));
 318         KASSERT((ng_fec_units[index] & (1 << bit)) == 0,
 319             ("%s: unit=%d is free", __func__, unit));
 320         ng_fec_units[index] |= (1 << bit);
 321         /*
 322          * XXX We could think about reducing the size of ng_fec_units[]
 323          * XXX here if the last portion is all ones
 324          * XXX At least free it if no more units
 325          * Needed if we are to eventually be able to unload.
 326          */
 327         ng_units_in_use--;
 328         if (ng_units_in_use == 0) { /* XXX make SMP safe */
 329                 FREE(ng_fec_units, M_NETGRAPH);
 330                 ng_fec_units_len = 0;
 331                 ng_fec_units = NULL;
 332         }
 333         mtx_unlock(&ng_fec_mtx);
 334 }
 335
 336 /************************************************************************
 337                         INTERFACE STUFF
 338  ************************************************************************/
 339
 340 static int
 341 ng_fec_addport(struct ng_fec_private *priv, char *iface)
 342 {
 343         struct ng_fec_bundle    *b;
 344         struct ifnet            *ifp, *bifp;
 345         struct ng_fec_portlist  *p, *new;
 346
 347         if (priv == NULL || iface == NULL)
 348                 return(EINVAL);
 349
 350         b = &priv->fec_bundle;
 351         ifp = priv->ifp;
 352
 353         /* Only allow reconfiguration if not running. */
 354         if (ifp->if_drv_flags & IFF_DRV_RUNNING) {
 355                 printf("fec%d: can't add new iface; bundle is running\n",
 356                     priv->unit);
 357                 return (EINVAL);
 358         }
 359
 360         /* Find the interface */
 361         bifp = ifunit(iface);
 362         if (bifp == NULL) {
 363                 printf("fec%d: tried to add iface %s, which "
 364                     "doesn't seem to exist\n", priv->unit, iface);
 365                 return(ENOENT);
 366         }
 367
 368         /* See if we have room in the bundle */
 369         if (b->fec_ifcnt == FEC_BUNDLESIZ) {
 370                 printf("fec%d: can't add new iface; bundle is full\n",
 371                     priv->unit);
 372                 return(ENOSPC);
 373         }
 374
 375         /* See if the interface is already in the bundle */
 376         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
 377                 if (p->fec_if == bifp) {
 378                         printf("fec%d: iface %s is already in this "
 379                             "bundle\n", priv->unit, iface);
 380                         return(EINVAL);
 381                 }
 382         }
 383
 384         /*
 385          * All interfaces must use the same output vector. Once the
 386          * user attaches an interface of one type, make all subsequent
 387          * interfaces have the same output vector.
 388          */
 389         if (b->fec_if_output != NULL) {
 390                 if (b->fec_if_output != bifp->if_output) {
 391                         printf("fec%d: iface %s is not the same type "
 392                             "as the other interface(s) already in "
 393                             "the bundle\n", priv->unit, iface);
 394                         return(EINVAL);
 395                 }
 396         }
 397
 398         /* Allocate new list entry. */
 399         MALLOC(new, struct ng_fec_portlist *,
 400             sizeof(struct ng_fec_portlist), M_NETGRAPH, M_NOWAIT);
 401         if (new == NULL)
 402                 return(ENOMEM);
 403
 404         IF_AFDATA_LOCK(bifp);
 405         IFP2NG(bifp) = priv->node;
 406         IF_AFDATA_UNLOCK(bifp);
 407
 408         /*
 409          * If this is the first interface added to the bundle,
 410          * use its MAC address for the virtual interface (and,
 411          * by extension, all the other ports in the bundle).
 412          */
 413         if (b->fec_ifcnt == 0)
 414                 if_setlladdr(ifp, IF_LLADDR(bifp), ETHER_ADDR_LEN);
 415
 416         b->fec_btype = FEC_BTYPE_MAC;
 417         new->fec_idx = b->fec_ifcnt;
 418         b->fec_ifcnt++;
 419
 420         /* Save the real MAC address. */
 421         bcopy(IF_LLADDR(bifp),
 422             (char *)&new->fec_mac, ETHER_ADDR_LEN);
 423
 424         /* Set up phony MAC address. */
 425         if_setlladdr(bifp, IF_LLADDR(ifp), ETHER_ADDR_LEN);
 426
 427         /* Save original input vector */
 428         new->fec_if_input = bifp->if_input;
 429
 430         /* Override it with our own */
 431         bifp->if_input = ng_fec_input;
 432
 433         /* Save output vector too. */
 434         if (b->fec_if_output == NULL)
 435                 b->fec_if_output = bifp->if_output;
 436
 437         /* Add to the queue */
 438         new->fec_if = bifp;
 439         new->fec_ifstat = -1;
 440         TAILQ_INSERT_TAIL(&b->ng_fec_ports, new, fec_list);
 441
 442         return(0);
 443 }
 444
 445 static int
 446 ng_fec_delport(struct ng_fec_private *priv, char *iface)
 447 {
 448         struct ng_fec_bundle    *b;
 449         struct ifnet            *ifp, *bifp;
 450         struct ng_fec_portlist  *p;
 451
 452         if (priv == NULL || iface == NULL)
 453                 return(EINVAL);
 454
 455         b = &priv->fec_bundle;
 456         ifp = priv->ifp;
 457
 458         /* Only allow reconfiguration if not running. */
 459         if (ifp->if_drv_flags & IFF_DRV_RUNNING) {
 460                 printf("fec%d: can't remove iface; bundle is running\n",
 461                     priv->unit);
 462                 return (EINVAL);
 463         }
 464
 465         /* Find the interface */
 466         bifp = ifunit(iface);
 467         if (bifp == NULL) {
 468                 printf("fec%d: tried to remove iface %s, which "
 469                     "doesn't seem to exist\n", priv->unit, iface);
 470                 return(ENOENT);
 471         }
 472
 473         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
 474                 if (p->fec_if == bifp)
 475                         break;
 476         }
 477
 478         if (p == NULL) {
 479                 printf("fec%d: tried to remove iface %s which "
 480                     "is not in our bundle\n", priv->unit, iface);
 481                 return(EINVAL);
 482         }
 483
 484         /* Stop interface */
 485         bifp->if_flags &= ~IFF_UP;
 486         (*bifp->if_ioctl)(bifp, SIOCSIFFLAGS, NULL);
 487
 488         /* Restore MAC address. */
 489         if_setlladdr(bifp, (u_char *)&p->fec_mac, ETHER_ADDR_LEN);
 490
 491         /* Restore input vector */
 492         bifp->if_input = p->fec_if_input;
 493
 494         /* Remove our node context pointer. */
 495         IF_AFDATA_LOCK(bifp);
 496         IFP2NG(bifp) = NULL;
 497         IF_AFDATA_UNLOCK(bifp);
 498
 499         /* Delete port */
 500         TAILQ_REMOVE(&b->ng_fec_ports, p, fec_list);
 501         FREE(p, M_NETGRAPH);
 502         b->fec_ifcnt--;
 503
 504         if (b->fec_ifcnt == 0)
 505                 b->fec_if_output = NULL;
 506
 507         return(0);
 508 }
 509
 510 /*
 511  * Pass an ioctl command down to all the underyling interfaces in a
 512  * bundle. Used for setting multicast filters and flags.
 513  */
 514
 515 static int
 516 ng_fec_setport(struct ifnet *ifp, u_long command, caddr_t data)
 517 {
 518         struct ng_fec_private   *priv;
 519         struct ng_fec_bundle    *b;
 520         struct ifnet            *oifp;
 521         struct ng_fec_portlist  *p;
 522
 523         priv = ifp->if_softc;
 524         b = &priv->fec_bundle;
 525
 526         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
 527                 oifp = p->fec_if;
 528                 if (oifp != NULL)
 529                         (*oifp->if_ioctl)(oifp, command, data);
 530         }
 531
 532         return(0);
 533 }
 534
 535 static void
 536 ng_fec_init(void *arg)
 537 {
 538         struct ng_fec_private   *priv;
 539         struct ng_fec_bundle    *b;
 540         struct ifnet            *ifp, *bifp;
 541         struct ng_fec_portlist  *p;
 542
 543         priv = arg;
 544         ifp = priv->ifp;
 545         b = &priv->fec_bundle;
 546
 547         if (b->fec_ifcnt != 2 && b->fec_ifcnt != FEC_BUNDLESIZ) {
 548                 printf("fec%d: invalid bundle "
 549                     "size: %d\n", priv->unit,
 550                     b->fec_ifcnt);
 551                 return;
 552         }
 553
 554         ng_fec_stop(ifp);
 555
 556         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
 557                 bifp = p->fec_if;
 558                 bifp->if_flags |= IFF_UP;
 559                 (*bifp->if_ioctl)(bifp, SIOCSIFFLAGS, NULL);
 560                 /* mark iface as up and let the monitor check it */
 561                 p->fec_ifstat = -1;
 562         }
 563
 564         ifp->if_drv_flags &= ~(IFF_DRV_OACTIVE);
 565         ifp->if_drv_flags |= IFF_DRV_RUNNING;
 566
 567         priv->fec_ch = timeout(ng_fec_tick, priv, hz);
 568
 569         return;
 570 }
 571
 572 static void
 573 ng_fec_stop(struct ifnet *ifp)
 574 {
 575         struct ng_fec_private   *priv;
 576         struct ng_fec_bundle    *b;
 577         struct ifnet            *bifp;
 578         struct ng_fec_portlist  *p;
 579
 580         priv = ifp->if_softc;
 581         b = &priv->fec_bundle;
 582
 583         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
 584                 bifp = p->fec_if;
 585                 bifp->if_flags &= ~IFF_UP;
 586                 (*bifp->if_ioctl)(bifp, SIOCSIFFLAGS, NULL);
 587         }
 588
 589         untimeout(ng_fec_tick, priv, priv->fec_ch);
 590
 591         ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
 592
 593         return;
 594 }
 595
 596 static void
 597 ng_fec_tick(void *arg)
 598 {
 599         struct ng_fec_private   *priv;
 600         struct ng_fec_bundle    *b;
 601         struct ifmediareq       ifmr;
 602         struct ifnet            *ifp;
 603         struct ng_fec_portlist  *p;
 604         int                     error = 0;
 605
 606         priv = arg;
 607         b = &priv->fec_bundle;
 608
 609         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
 610                 bzero((char *)&ifmr, sizeof(ifmr));
 611                 ifp = p->fec_if;
 612                 error = (*ifp->if_ioctl)(ifp, SIOCGIFMEDIA, (caddr_t)&ifmr);
 613                 if (error) {
 614                         printf("fec%d: failed to check status "
 615                             "of link %s\n", priv->unit, ifp->if_xname);
 616                         continue;
 617                 }
 618
 619                 if (ifmr.ifm_status & IFM_AVALID) {
 620                         if (ifmr.ifm_status & IFM_ACTIVE) {
 621                                 if (p->fec_ifstat == -1 ||
 622                                     p->fec_ifstat == 0) {
 623                                         p->fec_ifstat = 1;
 624                                         printf("fec%d: port %s in bundle "
 625                                             "is up\n", priv->unit,
 626                                             ifp->if_xname);
 627                                 }
 628                         } else {
 629                                 if (p->fec_ifstat == -1 ||
 630                                     p->fec_ifstat == 1) {
 631                                         p->fec_ifstat = 0;
 632                                         printf("fec%d: port %s in bundle "
 633                                             "is down\n", priv->unit,
 634                                             ifp->if_xname);
 635                                 }
 636                         }
 637                 }
 638         }
 639
 640         ifp = priv->ifp;
 641         if (ifp->if_drv_flags & IFF_DRV_RUNNING)
 642                 priv->fec_ch = timeout(ng_fec_tick, priv, hz);
 643
 644         return;
 645 }
 646
 647 static int
 648 ng_fec_ifmedia_upd(struct ifnet *ifp)
 649 {
 650         return(0);
 651 }
 652
 653 static void ng_fec_ifmedia_sts(struct ifnet *ifp,
 654         struct ifmediareq *ifmr)
 655 {
 656         struct ng_fec_private   *priv;
 657         struct ng_fec_bundle    *b;
 658         struct ng_fec_portlist  *p;
 659
 660         priv = ifp->if_softc;
 661         b = &priv->fec_bundle;
 662
 663         ifmr->ifm_status = IFM_AVALID;
 664         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
 665                 if (p->fec_ifstat == 1) {
 666                         ifmr->ifm_status |= IFM_ACTIVE;
 667                         break;
 668                 }
 669         }
 670
 671         return;
 672 }
 673
 674 /*
 675  * Process an ioctl for the virtual interface
 676  */
 677 static int
 678 ng_fec_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
 679 {
 680         struct ifreq *const ifr = (struct ifreq *) data;
 681         int s, error = 0;
 682         struct ng_fec_private   *priv;
 683         struct ng_fec_bundle    *b;
 684
 685         priv = ifp->if_softc;
 686         b = &priv->fec_bundle;
 687
 688 #ifdef DEBUG
 689         ng_fec_print_ioctl(ifp, command, data);
 690 #endif
 691         s = splimp();
 692         switch (command) {
 693
 694         /* These two are mostly handled at a higher layer */
 695         case SIOCSIFADDR:
 696         case SIOCGIFADDR:
 697         case SIOCSIFMTU:
 698                 error = ether_ioctl(ifp, command, data);
 699                 break;
 700
 701         /* Set flags */
 702         case SIOCSIFFLAGS:
 703                 /*
 704                  * If the interface is marked up and stopped, then start it.
 705                  * If it is marked down and running, then stop it.
 706                  */
 707                 if (ifr->ifr_flags & IFF_UP) {
 708                         if (!(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
 709                                 /* Sanity. */
 710                                 if (b->fec_ifcnt != 2 &&
 711                                     b->fec_ifcnt != FEC_BUNDLESIZ) {
 712                                         printf("fec%d: invalid bundle "
 713                                             "size: %d\n", priv->unit,
 714                                             b->fec_ifcnt);
 715                                         error = EINVAL;
 716                                         break;
 717                                 }
 718                                 ng_fec_init(priv);
 719                         }
 720                         /*
 721                          * Bubble down changes in promisc mode to
 722                          * underlying interfaces.
 723                          */
 724                         if ((ifp->if_flags & IFF_PROMISC) !=
 725                             (priv->if_flags & IFF_PROMISC)) {
 726                                 ng_fec_setport(ifp, command, data);
 727                                 priv->if_flags = ifp->if_flags;
 728                         }
 729                 } else {
 730                         if (ifp->if_drv_flags & IFF_DRV_RUNNING)
 731                                 ng_fec_stop(ifp);
 732                 }
 733                 break;
 734
 735         case SIOCADDMULTI:
 736         case SIOCDELMULTI:
 737                 ng_fec_setport(ifp, command, data);
 738                 error = 0;
 739                 break;
 740         case SIOCGIFMEDIA:
 741         case SIOCSIFMEDIA:
 742                 error = ifmedia_ioctl(ifp, ifr, &priv->ifmedia, command);
 743                 break;
 744         /* Stuff that's not supported */
 745         case SIOCSIFPHYS:
 746                 error = EOPNOTSUPP;
 747                 break;
 748
 749         default:
 750                 error = EINVAL;
 751                 break;
 752         }
 753         (void) splx(s);
 754         return (error);
 755 }
 756
 757 /*
 758  * This routine spies on mbufs received by underlying network device
 759  * drivers. When we add an interface to our bundle, we override its
 760  * if_input routine with a pointer to ng_fec_input(). This means we
 761  * get to look at all the device's packets before sending them to the
 762  * real ether_input() for processing by the stack. Once we verify the
 763  * packet comes from an interface that's been aggregated into
 764  * our bundle, we fix up the rcvif pointer and increment our
 765  * packet counters so that it looks like the frames are actually
 766  * coming from us.
 767  */
 768 static void
 769 ng_fec_input(struct ifnet *ifp, struct mbuf *m0)
 770 {
 771         struct ng_node          *node;
 772         struct ng_fec_private   *priv;
 773         struct ng_fec_bundle    *b;
 774         struct ifnet            *bifp;
 775         struct ng_fec_portlist  *p;
 776
 777         /* Sanity check */
 778         if (ifp == NULL || m0 == NULL)
 779                 return;
 780
 781         node = IFP2NG(ifp);
 782
 783         /* Sanity check part II */
 784         if (node == NULL)
 785                 return;
 786
 787         priv = NG_NODE_PRIVATE(node);
 788         b = &priv->fec_bundle;
 789         bifp = priv->ifp;
 790
 791         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
 792                 if (p->fec_if == m0->m_pkthdr.rcvif)
 793                         break;
 794         }
 795
 796         /* Wasn't meant for us; leave this frame alone. */
 797         if (p == NULL)
 798                 return;
 799
 800         /*
 801          * Check for a BPF tap on the underlying interface. This
 802          * is mainly a debugging aid: it allows tcpdump-ing of an
 803          * individual interface in a bundle to work, which it
 804          * otherwise would not. BPF tapping of our own aggregate
 805          * interface will occur once we call ether_input().
 806          */
 807         BPF_MTAP(m0->m_pkthdr.rcvif, m0);
 808
 809         /* Convince the system that this is our frame. */
 810         m0->m_pkthdr.rcvif = bifp;
 811         bifp->if_ipackets++;
 812         bifp->if_ibytes += m0->m_pkthdr.len + sizeof(struct ether_header);
 813
 814         (*bifp->if_input)(bifp, m0);
 815
 816         return;
 817 }
 818
 819 /*
 820  * Take a quick peek at the packet and see if it's ok for us to use
 821  * the inet or inet6 hash methods on it, if they're enabled. We do
 822  * this by setting flags in the mbuf header. Once we've made up our
 823  * mind what to do, we pass the frame to output vector for further
 824  * processing.
 825  */
 826
 827 static int
 828 ng_fec_output(struct ifnet *ifp, struct mbuf *m,
 829                 struct sockaddr *dst, struct rtentry *rt0)
 830 {
 831         const priv_p priv = (priv_p) ifp->if_softc;
 832         struct ng_fec_bundle *b;
 833         int error;
 834
 835         /* Check interface flags */
 836         if (!((ifp->if_flags & IFF_UP) &&
 837             (ifp->if_drv_flags & IFF_DRV_RUNNING))) {
 838                 m_freem(m);
 839                 return (ENETDOWN);
 840         }
 841
 842         b = &priv->fec_bundle;
 843
 844         switch (b->fec_btype) {
 845         case FEC_BTYPE_MAC:
 846                 m->m_flags |= M_FEC_MAC;
 847                 break;
 848 #ifdef INET
 849         case FEC_BTYPE_INET:
 850                 /*
 851                  * We can't use the INET address port selection
 852                  * scheme if this isn't an INET packet.
 853                  */
 854                 if (dst->sa_family == AF_INET)
 855                         m->m_flags |= M_FEC_INET;
 856 #ifdef INET6
 857                 else if (dst->sa_family == AF_INET6)
 858                         m->m_flags |= M_FEC_INET6;
 859 #endif
 860                 else {
 861 #ifdef DEBUG
 862                         if_printf(ifp, "can't do inet aggregation of non "
 863                             "inet packet\n");
 864 #endif
 865                         m->m_flags |= M_FEC_MAC;
 866                 }
 867                 break;
 868 #endif
 869         default:
 870                 if_printf(ifp, "bogus hash type: %d\n",
 871                     b->fec_btype);
 872                 m_freem(m);
 873                 return(EINVAL);
 874                 break;
 875         }
 876
 877         /*
 878          * Pass the frame to the output vector for all the protocol
 879          * handling. This will put the ethernet header on the packet
 880          * for us.
 881          */
 882         priv->if_error = 0;
 883         error = (*b->fec_if_output)(ifp, m, dst, rt0);
 884         if (priv->if_error && !error)
 885                 error = priv->if_error;
 886
 887         return(error);
 888 }
 889
 890 /*
 891  * Apply a hash to the source and destination addresses in the packet
 892  * in order to select an interface. Also check link status and handle
 893  * dead links accordingly.
 894  */
 895
 896 static int
 897 ng_fec_choose_port(struct ng_fec_bundle *b,
 898         struct mbuf *m, struct ifnet **ifp)
 899 {
 900         struct ether_header     *eh;
 901         struct mbuf             *m0;
 902 #ifdef INET
 903         struct ip               *ip;
 904 #ifdef INET6
 905         struct ip6_hdr          *ip6;
 906 #endif
 907 #endif
 908
 909         struct ng_fec_portlist  *p;
 910         int                     port = 0, mask;
 911
 912         /*
 913          * If there are only two ports, mask off all but the
 914          * last bit for XORing. If there are 4, mask off all
 915          * but the last 2 bits.
 916          */
 917         mask = b->fec_ifcnt == 2 ? 0x1 : 0x3;
 918         eh = mtod(m, struct ether_header *);
 919 #ifdef INET
 920         ip = (struct ip *)(mtod(m, char *) +
 921             sizeof(struct ether_header));
 922 #ifdef INET6
 923         ip6 = (struct ip6_hdr *)(mtod(m, char *) +
 924             sizeof(struct ether_header));
 925 #endif
 926 #endif
 927
 928         /*
 929          * The fg_fec_output() routine is supposed to leave a
 930          * flag for us in the mbuf that tells us what hash to
 931          * use, but sometimes a new mbuf is prepended to the
 932          * chain, so we have to search every mbuf in the chain
 933          * to find the flags.
 934          */
 935         m0 = m;
 936         while (m0) {
 937                 if (m0->m_flags & (M_FEC_MAC|M_FEC_INET|M_FEC_INET6))
 938                         break;
 939                 m0 = m0->m_next;
 940         }
 941         if (m0 == NULL)
 942                 return(EINVAL);
 943
 944         switch (m0->m_flags & (M_FEC_MAC|M_FEC_INET|M_FEC_INET6)) {
 945         case M_FEC_MAC:
 946                 port = (eh->ether_dhost[5] ^
 947                     eh->ether_shost[5]) & mask;
 948                 break;
 949 #ifdef INET
 950         case M_FEC_INET:
 951                 port = (ntohl(ip->ip_dst.s_addr) ^
 952                     ntohl(ip->ip_src.s_addr)) & mask;
 953                 break;
 954 #ifdef INET6
 955         case M_FEC_INET6:
 956                 port = (ip6->ip6_dst.s6_addr[15] ^
 957                     ip6->ip6_dst.s6_addr[15]) & mask;
 958                 break;
 959 #endif
 960 #endif
 961         default:
 962                 return(EINVAL);
 963                         break;
 964         }
 965
 966         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
 967                 if (port == p->fec_idx)
 968                         break;
 969         }
 970
 971         /*
 972          * Now that we've chosen a port, make sure it's
 973          * alive. If it's not alive, cycle through the bundle
 974          * looking for a port that is alive. If we don't find
 975          * any, return an error.
 976          */
 977         if (p->fec_ifstat != 1) {
 978                 struct ng_fec_portlist  *n = NULL;
 979
 980                 n = TAILQ_NEXT(p, fec_list);
 981                 if (n == NULL)
 982                         n = TAILQ_FIRST(&b->ng_fec_ports);
 983                 while (n != p) {
 984                         if (n->fec_ifstat == 1)
 985                                 break;
 986                         n = TAILQ_NEXT(n, fec_list);
 987                         if (n == NULL)
 988                                 n = TAILQ_FIRST(&b->ng_fec_ports);
 989                 }
 990                 if (n == p)
 991                         return(EAGAIN);
 992                 p = n;
 993         }
 994
 995         *ifp = p->fec_if;
 996
 997         return(0);
 998 }
 999
1000 /*
1001  * Now that the packet has been run through ether_output(), yank it
1002  * off our own send queue and stick it on the queue for the appropriate
1003  * underlying physical interface. Note that if the interface's send
1004  * queue is full, we save an error status in our private netgraph
1005  * space which will eventually be handed up to ng_fec_output(), which
1006  * will return it to the rest of the IP stack. We need to do this
1007  * in order to duplicate the effect of ether_output() returning ENOBUFS
1008  * when it detects that an interface's send queue is full. There's no
1009  * other way to signal the error status from here since the if_start()
1010  * routine is spec'ed to return void.
1011  *
1012  * Once the frame is queued, we call ether_output_frame() to initiate
1013  * transmission.
1014  */
1015 static void
1016 ng_fec_start(struct ifnet *ifp)
1017 {
1018         struct ng_fec_private   *priv;
1019         struct ng_fec_bundle    *b;
1020         struct ifnet            *oifp = NULL;
1021         struct mbuf             *m0;
1022         int                     error;
1023
1024         priv = ifp->if_softc;
1025         b = &priv->fec_bundle;
1026
1027         IF_DEQUEUE(&ifp->if_snd, m0);
1028         if (m0 == NULL)
1029                 return;
1030
1031         BPF_MTAP(ifp, m0);
1032
1033         /* Queue up packet on the proper port. */
1034         error = ng_fec_choose_port(b, m0, &oifp);
1035         if (error) {
1036                 ifp->if_ierrors++;
1037                 m_freem(m0);
1038                 priv->if_error = ENOBUFS;
1039                 return;
1040         }
1041         ifp->if_opackets++;
1042
1043         priv->if_error = IF_HANDOFF(&oifp->if_snd, m0, oifp) ? 0 : ENOBUFS;
1044
1045         return;
1046 }
1047
1048 #ifdef DEBUG
1049 /*
1050  * Display an ioctl to the virtual interface
1051  */
1052
1053 static void
1054 ng_fec_print_ioctl(struct ifnet *ifp, int command, caddr_t data)
1055 {
1056         char   *str;
1057
1058         switch (command & IOC_DIRMASK) {
1059         case IOC_VOID:
1060                 str = "IO";
1061                 break;
1062         case IOC_OUT:
1063                 str = "IOR";
1064                 break;
1065         case IOC_IN:
1066                 str = "IOW";
1067                 break;
1068         case IOC_INOUT:
1069                 str = "IORW";
1070                 break;
1071         default:
1072                 str = "IO??";
1073         }
1074         log(LOG_DEBUG, "%s: %s('%c', %d, char[%d])\n",
1075                ifp->if_xname,
1076                str,
1077                IOCGROUP(command),
1078                command & 0xff,
1079                IOCPARM_LEN(command));
1080 }
1081 #endif /* DEBUG */
1082
1083 /************************************************************************
1084                         NETGRAPH NODE STUFF
1085  ************************************************************************/
1086
1087 /*
1088  * Constructor for a node
1089  */
1090 static int
1091 ng_fec_constructor(node_p node)
1092 {
1093         char ifname[NG_FEC_FEC_NAME_MAX + 1];
1094         struct ifnet *ifp;
1095         priv_p priv;
1096         const uint8_t eaddr[ETHER_ADDR_LEN] = {0, 0, 0, 0, 0, 0};
1097         struct ng_fec_bundle *b;
1098         int error = 0;
1099
1100         /* Allocate node and interface private structures */
1101         MALLOC(priv, priv_p, sizeof(*priv), M_NETGRAPH, M_NOWAIT | M_ZERO);
1102         if (priv == NULL)
1103                 return (ENOMEM);
1104
1105         ifp = priv->ifp = if_alloc(IFT_ETHER);
1106         if (ifp == NULL) {
1107                 FREE(priv, M_NETGRAPH);
1108                 return (ENOSPC);
1109         }
1110         b = &priv->fec_bundle;
1111
1112         /* Link them together */
1113         ifp->if_softc = priv;
1114
1115         /* Get an interface unit number */
1116         if ((error = ng_fec_get_unit(&priv->unit)) != 0) {
1117                 if_free(ifp);
1118                 FREE(priv, M_NETGRAPH);
1119                 return (error);
1120         }
1121
1122         /* Link together node and private info */
1123         NG_NODE_SET_PRIVATE(node, priv);
1124         priv->node = node;
1125
1126         /* Initialize interface structure */
1127         if_initname(ifp, NG_FEC_FEC_NAME, priv->unit);
1128         ifp->if_start = ng_fec_start;
1129         ifp->if_ioctl = ng_fec_ioctl;
1130         ifp->if_init = ng_fec_init;
1131         ifp->if_watchdog = NULL;
1132         ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
1133         ifp->if_mtu = NG_FEC_MTU_DEFAULT;
1134         ifp->if_flags = (IFF_SIMPLEX|IFF_BROADCAST|IFF_MULTICAST);
1135         ifp->if_addrlen = 0;                    /* XXX */
1136         ifp->if_hdrlen = 0;                     /* XXX */
1137         ifp->if_baudrate = 100000000;           /* XXX */
1138         TAILQ_INIT(&ifp->if_addrhead); /* XXX useless - done in if_attach */
1139
1140         /* Give this node the same name as the interface (if possible) */
1141         bzero(ifname, sizeof(ifname));
1142         strlcpy(ifname, ifp->if_xname, sizeof(ifname));
1143         if (ng_name_node(node, ifname) != 0)
1144                 log(LOG_WARNING, "%s: can't acquire netgraph name\n", ifname);
1145
1146         /* Attach the interface */
1147         ether_ifattach(ifp, eaddr);
1148         callout_handle_init(&priv->fec_ch);
1149
1150         /* Override output method with our own */
1151         ifp->if_output = ng_fec_output;
1152
1153         TAILQ_INIT(&b->ng_fec_ports);
1154         b->fec_ifcnt = 0;
1155
1156         ifmedia_init(&priv->ifmedia, 0,
1157             ng_fec_ifmedia_upd, ng_fec_ifmedia_sts);
1158         ifmedia_add(&priv->ifmedia, IFM_ETHER|IFM_NONE, 0, NULL);
1159         ifmedia_set(&priv->ifmedia, IFM_ETHER|IFM_NONE);
1160
1161         /* Done */
1162         return (0);
1163 }
1164
1165 /*
1166  * Receive a control message
1167  */
1168 static int
1169 ng_fec_rcvmsg(node_p node, item_p item, hook_p lasthook)
1170 {
1171         const priv_p priv = NG_NODE_PRIVATE(node);
1172         struct ng_fec_bundle    *b;
1173         struct ng_mesg *resp = NULL;
1174         struct ng_mesg *msg;
1175         char *ifname;
1176         int error = 0;
1177
1178         NGI_GET_MSG(item, msg);
1179         b = &priv->fec_bundle;
1180
1181         switch (msg->header.typecookie) {
1182         case NGM_FEC_COOKIE:
1183                 switch (msg->header.cmd) {
1184                 case NGM_FEC_ADD_IFACE:
1185                         ifname = msg->data;
1186                         error = ng_fec_addport(priv, ifname);
1187                         break;
1188                 case NGM_FEC_DEL_IFACE:
1189                         ifname = msg->data;
1190                         error = ng_fec_delport(priv, ifname);
1191                         break;
1192                 case NGM_FEC_SET_MODE_MAC:
1193                         b->fec_btype = FEC_BTYPE_MAC;
1194                         break;
1195 #ifdef INET
1196                 case NGM_FEC_SET_MODE_INET:
1197                         b->fec_btype = FEC_BTYPE_INET;
1198                         break;
1199 #ifdef INET6
1200                 case NGM_FEC_SET_MODE_INET6:
1201                         b->fec_btype = FEC_BTYPE_INET6;
1202                         break;
1203 #endif
1204 #endif
1205                 default:
1206                         error = EINVAL;
1207                         break;
1208                 }
1209                 break;
1210         default:
1211                 error = EINVAL;
1212                 break;
1213         }
1214         NG_RESPOND_MSG(error, node, item, resp);
1215         NG_FREE_MSG(msg);
1216         return (error);
1217 }
1218
1219 /*
1220  * Shutdown and remove the node and its associated interface.
1221  */
1222 static int
1223 ng_fec_shutdown(node_p node)
1224 {
1225         const priv_p priv = NG_NODE_PRIVATE(node);
1226         struct ng_fec_bundle *b;
1227         struct ng_fec_portlist  *p;
1228
1229         b = &priv->fec_bundle;
1230         ng_fec_stop(priv->ifp);
1231
1232         while (!TAILQ_EMPTY(&b->ng_fec_ports)) {
1233                 p = TAILQ_FIRST(&b->ng_fec_ports);
1234                 ng_fec_delport(priv, p->fec_if->if_xname);
1235         }
1236
1237         ether_ifdetach(priv->ifp);
1238         if_free_type(priv->ifp, IFT_ETHER);
1239         ifmedia_removeall(&priv->ifmedia);
1240         ng_fec_free_unit(priv->unit);
1241         FREE(priv, M_NETGRAPH);
1242         NG_NODE_SET_PRIVATE(node, NULL);
1243         NG_NODE_UNREF(node);
1244         return (0);
1245 }
1246
1247 /*
1248  * Handle loading and unloading for this node type.
1249  */
1250 static int
1251 ng_fec_mod_event(module_t mod, int event, void *data)
1252 {
1253         int error = 0;
1254
1255         switch (event) {
1256         case MOD_LOAD:
1257                 mtx_init(&ng_fec_mtx, "ng_fec", NULL, MTX_DEF);
1258                 break;
1259         case MOD_UNLOAD:
1260                 mtx_destroy(&ng_fec_mtx);
1261                 break;
1262         default:
1263                 error = EOPNOTSUPP;
1264                 break;
1265         }
1266         return (error);
1267 }