sys/netgraph/fec/ng_fec.c

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