kernel tree reorganization stage 1: Major cvs repository work (not logged as
[dragonfly.git] / 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.3 2003/08/07 21:17:31 dillon 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 static int      ng_fec_output(struct ifnet *ifp, struct mbuf *m0,
183                         struct sockaddr *dst, struct rtentry *rt0);
184 static void     ng_fec_tick(void *arg);
185 static int      ng_fec_addport(struct ng_fec_private *priv, char *iface);
186 static int      ng_fec_delport(struct ng_fec_private *priv, char *iface);
187
188 #ifdef DEBUG
189 static void     ng_fec_print_ioctl(struct ifnet *ifp, int cmd, caddr_t data);
190 #endif
191
192 /* Netgraph methods */
193 static ng_constructor_t ng_fec_constructor;
194 static ng_rcvmsg_t      ng_fec_rcvmsg;
195 static ng_shutdown_t    ng_fec_rmnode;
196
197 /* List of commands and how to convert arguments to/from ASCII */
198 static const struct ng_cmdlist ng_fec_cmds[] = {
199         {
200           NGM_FEC_COOKIE,
201           NGM_FEC_ADD_IFACE,
202           "add_iface",
203           &ng_parse_string_type,
204           NULL,
205         },
206         {
207           NGM_FEC_COOKIE,
208           NGM_FEC_DEL_IFACE,
209           "del_iface",
210           &ng_parse_string_type,
211           NULL,
212         },
213         {
214           NGM_FEC_COOKIE,
215           NGM_FEC_SET_MODE_MAC,
216           "set_mode_mac",
217           NULL,
218           NULL,
219         },
220         {
221           NGM_FEC_COOKIE,
222           NGM_FEC_SET_MODE_INET,
223           "set_mode_inet",
224           NULL,
225           NULL,
226         },
227         { 0 }
228 };
229
230 /* Node type descriptor */
231 static struct ng_type typestruct = {
232         NG_VERSION,
233         NG_FEC_NODE_TYPE,
234         NULL,
235         ng_fec_constructor,
236         ng_fec_rcvmsg,
237         ng_fec_rmnode,
238         NULL,
239         NULL,
240         NULL,
241         NULL,
242         NULL,
243         NULL,
244         ng_fec_cmds
245 };
246 NETGRAPH_INIT(fec, &typestruct);
247
248 /* We keep a bitmap indicating which unit numbers are free.
249    One means the unit number is free, zero means it's taken. */
250 static int      *ng_fec_units = NULL;
251 static int      ng_fec_units_len = 0;
252 static int      ng_units_in_use = 0;
253
254 #define UNITS_BITSPERWORD       (sizeof(*ng_fec_units) * NBBY)
255
256 /*
257  * Find the first free unit number for a new interface.
258  * Increase the size of the unit bitmap as necessary.
259  */
260 static __inline__ int
261 ng_fec_get_unit(int *unit)
262 {
263         int index, bit;
264
265         for (index = 0; index < ng_fec_units_len
266             && ng_fec_units[index] == 0; index++);
267         if (index == ng_fec_units_len) {                /* extend array */
268                 int i, *newarray, newlen;
269
270                 newlen = (2 * ng_fec_units_len) + 4;
271                 MALLOC(newarray, int *, newlen * sizeof(*ng_fec_units),
272                     M_NETGRAPH, M_NOWAIT);
273                 if (newarray == NULL)
274                         return (ENOMEM);
275                 bcopy(ng_fec_units, newarray,
276                     ng_fec_units_len * sizeof(*ng_fec_units));
277                 for (i = ng_fec_units_len; i < newlen; i++)
278                         newarray[i] = ~0;
279                 if (ng_fec_units != NULL)
280                         FREE(ng_fec_units, M_NETGRAPH);
281                 ng_fec_units = newarray;
282                 ng_fec_units_len = newlen;
283         }
284         bit = ffs(ng_fec_units[index]) - 1;
285         KASSERT(bit >= 0 && bit <= UNITS_BITSPERWORD - 1,
286             ("%s: word=%d bit=%d", __FUNCTION__, ng_fec_units[index], bit));
287         ng_fec_units[index] &= ~(1 << bit);
288         *unit = (index * UNITS_BITSPERWORD) + bit;
289         ng_units_in_use++;
290         return (0);
291 }
292
293 /*
294  * Free a no longer needed unit number.
295  */
296 static __inline__ void
297 ng_fec_free_unit(int unit)
298 {
299         int index, bit;
300
301         index = unit / UNITS_BITSPERWORD;
302         bit = unit % UNITS_BITSPERWORD;
303         KASSERT(index < ng_fec_units_len,
304             ("%s: unit=%d len=%d", __FUNCTION__, unit, ng_fec_units_len));
305         KASSERT((ng_fec_units[index] & (1 << bit)) == 0,
306             ("%s: unit=%d is free", __FUNCTION__, unit));
307         ng_fec_units[index] |= (1 << bit);
308         /*
309          * XXX We could think about reducing the size of ng_fec_units[]
310          * XXX here if the last portion is all ones
311          * XXX At least free it if no more units.
312          * Needed if we are eventually be able to unload.
313          */
314         ng_units_in_use++;
315         if (ng_units_in_use == 0) { /* XXX make SMP safe */
316                 FREE(ng_fec_units, M_NETGRAPH);
317                 ng_fec_units_len = 0;
318                 ng_fec_units = NULL;
319         }
320 }
321
322 /************************************************************************
323                         INTERFACE STUFF
324  ************************************************************************/
325
326 static int
327 ng_fec_addport(struct ng_fec_private *priv, char *iface)
328 {
329         struct ng_fec_bundle    *b;
330         struct ifnet            *ifp, *bifp;
331         struct arpcom           *ac;
332         struct ifaddr           *ifa;
333         struct sockaddr_dl      *sdl;
334         struct ng_fec_portlist  *p, *new;
335
336         if (priv == NULL || iface == NULL)
337                 return(EINVAL);
338
339         b = &priv->fec_bundle;
340         ifp = &priv->arpcom.ac_if;
341
342         /* Find the interface */
343         bifp = ifunit(iface);
344         if (bifp == NULL) {
345                 printf("fec%d: tried to add iface %s, which "
346                     "doesn't seem to exist\n", priv->unit, iface);
347                 return(ENOENT);
348         }
349
350         /* See if we have room in the bundle */
351         if (b->fec_ifcnt == FEC_BUNDLESIZ) {
352                 printf("fec%d: can't add new iface; bundle is full\n",
353                     priv->unit);
354                 return(ENOSPC);
355         }
356
357         /* See if the interface is already in the bundle */
358         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
359                 if (p->fec_if == bifp) {
360                         printf("fec%d: iface %s is already in this "
361                             "bundle\n", priv->unit, iface);
362                         return(EINVAL);
363                 }
364         }
365
366         /* Allocate new list entry. */
367         MALLOC(new, struct ng_fec_portlist *,
368             sizeof(struct ng_fec_portlist), M_NETGRAPH, M_NOWAIT);
369         if (new == NULL)
370                 return(ENOMEM);
371
372         ac = (struct arpcom *)bifp;
373         ac->ac_netgraph = priv->node;
374
375         /*
376          * If this is the first interface added to the bundle,
377          * use its MAC address for the virtual interface (and,
378          * by extension, all the other ports in the bundle).
379          */
380         if (b->fec_ifcnt == 0) {
381                 ifa = ifnet_addrs[ifp->if_index - 1];
382                 sdl = (struct sockaddr_dl *)ifa->ifa_addr;
383                 bcopy((char *)ac->ac_enaddr,
384                     priv->arpcom.ac_enaddr, ETHER_ADDR_LEN);
385                 bcopy((char *)ac->ac_enaddr,
386                     LLADDR(sdl), ETHER_ADDR_LEN);
387         }
388
389         b->fec_btype = FEC_BTYPE_MAC;
390         new->fec_idx = b->fec_ifcnt;
391         b->fec_ifcnt++;
392
393         /* Save the real MAC address. */
394         bcopy((char *)ac->ac_enaddr,
395             (char *)&new->fec_mac, ETHER_ADDR_LEN);
396
397         /* Set up phony MAC address. */
398         ifa = ifnet_addrs[bifp->if_index - 1];
399         sdl = (struct sockaddr_dl *)ifa->ifa_addr;
400         bcopy(priv->arpcom.ac_enaddr, ac->ac_enaddr, ETHER_ADDR_LEN);
401         bcopy(priv->arpcom.ac_enaddr, LLADDR(sdl), ETHER_ADDR_LEN);
402
403         /* Add to the queue */
404         new->fec_if = bifp;
405         TAILQ_INSERT_TAIL(&b->ng_fec_ports, new, fec_list);
406
407         return(0);
408 }
409
410 static int
411 ng_fec_delport(struct ng_fec_private *priv, char *iface)
412 {
413         struct ng_fec_bundle    *b;
414         struct ifnet            *ifp, *bifp;
415         struct arpcom           *ac;
416         struct ifaddr           *ifa;
417         struct sockaddr_dl      *sdl;
418         struct ng_fec_portlist  *p;
419
420         if (priv == NULL || iface == NULL)
421                 return(EINVAL);
422
423         b = &priv->fec_bundle;
424         ifp = &priv->arpcom.ac_if;
425
426         /* Find the interface */
427         bifp = ifunit(iface);
428         if (bifp == NULL) {
429                 printf("fec%d: tried to remove iface %s, which "
430                     "doesn't seem to exist\n", priv->unit, iface);
431                 return(ENOENT);
432         }
433
434         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
435                 if (p->fec_if == bifp)
436                         break;
437         }
438
439         if (p == NULL) {
440                 printf("fec%d: tried to remove iface %s which "
441                     "is not in our bundle\n", priv->unit, iface);
442                 return(EINVAL);
443         }
444
445         /* Stop interface */
446         bifp->if_flags &= ~IFF_UP;
447         (*bifp->if_ioctl)(bifp, SIOCSIFFLAGS, NULL);
448
449         /* Restore MAC address. */
450         ac = (struct arpcom *)bifp;
451         ifa = ifnet_addrs[bifp->if_index - 1];
452         sdl = (struct sockaddr_dl *)ifa->ifa_addr;
453         bcopy((char *)&p->fec_mac, ac->ac_enaddr, ETHER_ADDR_LEN);
454         bcopy((char *)&p->fec_mac, LLADDR(sdl), ETHER_ADDR_LEN);
455
456         /* Delete port */
457         TAILQ_REMOVE(&b->ng_fec_ports, p, fec_list);
458         FREE(p, M_NETGRAPH);
459         b->fec_ifcnt--;
460
461         return(0);
462 }
463
464 /*
465  * Pass an ioctl command down to all the underyling interfaces in a
466  * bundle. Used for setting multicast filters and flags.
467  */
468
469 static int 
470 ng_fec_setport(struct ifnet *ifp, u_long command, caddr_t data)
471 {
472         struct ng_fec_private   *priv;
473         struct ng_fec_bundle    *b;
474         struct ifnet            *oifp;
475         struct ng_fec_portlist  *p;
476
477         priv = ifp->if_softc;
478         b = &priv->fec_bundle;
479
480         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
481                 oifp = p->fec_if;
482                 if (oifp != NULL)
483                         (*oifp->if_ioctl)(oifp, command, data);
484         }
485
486         return(0);
487 }
488
489 static void
490 ng_fec_init(void *arg)
491 {
492         struct ng_fec_private   *priv;
493         struct ng_fec_bundle    *b;
494         struct ifnet            *ifp, *bifp;
495         struct ng_fec_portlist  *p;
496
497         ifp = arg;
498         priv = ifp->if_softc;
499         b = &priv->fec_bundle;
500
501         if (b->fec_ifcnt == 1 || b->fec_ifcnt == 3) {
502                 printf("fec%d: invalid bundle "
503                     "size: %d\n", priv->unit,
504                     b->fec_ifcnt);
505                 return;
506         }
507
508         ng_fec_stop(ifp);
509
510         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
511                 bifp = p->fec_if;
512                 bifp->if_flags |= IFF_UP;
513                 (*bifp->if_ioctl)(bifp, SIOCSIFFLAGS, NULL);
514                 /* mark iface as up and let the monitor check it */
515                 p->fec_ifstat = -1;
516         }
517
518         priv->fec_ch = timeout(ng_fec_tick, priv, hz);
519
520         return;
521 }
522
523 static void
524 ng_fec_stop(struct ifnet *ifp)
525 {
526         struct ng_fec_private   *priv;
527         struct ng_fec_bundle    *b;
528         struct ifnet            *bifp;
529         struct ng_fec_portlist  *p;
530
531         priv = ifp->if_softc;
532         b = &priv->fec_bundle;
533
534         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
535                 bifp = p->fec_if;
536                 bifp->if_flags &= ~IFF_UP;
537                 (*bifp->if_ioctl)(bifp, SIOCSIFFLAGS, NULL);
538         }
539
540         untimeout(ng_fec_tick, priv, priv->fec_ch);
541
542         return;
543 }
544
545 static void
546 ng_fec_tick(void *arg)
547 {
548         struct ng_fec_private   *priv;
549         struct ng_fec_bundle    *b;
550         struct ifmediareq       ifmr;
551         struct ifnet            *ifp;
552         struct ng_fec_portlist  *p;
553         int                     error = 0;
554
555         priv = arg;
556         b = &priv->fec_bundle;
557
558         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
559                 bzero((char *)&ifmr, sizeof(ifmr));
560                 ifp = p->fec_if;
561                 error = (*ifp->if_ioctl)(ifp, SIOCGIFMEDIA, (caddr_t)&ifmr);
562                 if (error) {
563                         printf("fec%d: failed to check status "
564                             "of link %s%d\n", priv->unit, ifp->if_name,
565                             ifp->if_unit);
566                         continue;
567                 }
568
569                 if (ifmr.ifm_status & IFM_AVALID &&
570                     IFM_TYPE(ifmr.ifm_active) == IFM_ETHER) {
571                         if (ifmr.ifm_status & IFM_ACTIVE) {
572                                 if (p->fec_ifstat == -1 ||
573                                     p->fec_ifstat == 0) {
574                                         p->fec_ifstat = 1;
575                                         printf("fec%d: port %s%d in bundle "
576                                             "is up\n", priv->unit,
577                                             ifp->if_name, ifp->if_unit);
578                                 }
579                         } else {
580                                 if (p->fec_ifstat == -1 ||
581                                     p->fec_ifstat == 1) {
582                                         p->fec_ifstat = 0;
583                                         printf("fec%d: port %s%d in bundle "
584                                             "is down\n", priv->unit,
585                                             ifp->if_name, ifp->if_unit);
586                                 }
587                         }
588                 }
589         }
590
591         ifp = &priv->arpcom.ac_if;
592         if (ifp->if_flags & IFF_RUNNING)
593                 priv->fec_ch = timeout(ng_fec_tick, priv, hz);
594
595         return;
596 }
597
598 static int
599 ng_fec_ifmedia_upd(struct ifnet *ifp)
600 {
601         return(0);
602 }
603
604 static void ng_fec_ifmedia_sts(struct ifnet *ifp,
605         struct ifmediareq *ifmr)
606 {
607         struct ng_fec_private   *priv;
608         struct ng_fec_bundle    *b;
609         struct ng_fec_portlist  *p;
610
611         priv = ifp->if_softc;
612         b = &priv->fec_bundle;
613
614         ifmr->ifm_status = IFM_AVALID;
615         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
616                 if (p->fec_ifstat) {
617                         ifmr->ifm_status |= IFM_ACTIVE;
618                         break;
619                 }
620         }
621
622         return;
623 }
624
625 /*
626  * Process an ioctl for the virtual interface
627  */
628 static int
629 ng_fec_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
630 {
631         struct ifreq *const ifr = (struct ifreq *) data;
632         int s, error = 0;
633         struct ng_fec_private   *priv;
634         struct ng_fec_bundle    *b;
635
636         priv = ifp->if_softc;
637         b = &priv->fec_bundle;
638
639 #ifdef DEBUG
640         ng_fec_print_ioctl(ifp, command, data);
641 #endif
642         s = splimp();
643         switch (command) {
644
645         /* These two are mostly handled at a higher layer */
646         case SIOCSIFADDR:
647         case SIOCGIFADDR:
648         case SIOCSIFMTU:
649                 error = ether_ioctl(ifp, command, data);
650                 break;
651
652         /* Set flags */
653         case SIOCSIFFLAGS:
654                 /*
655                  * If the interface is marked up and stopped, then start it.
656                  * If it is marked down and running, then stop it.
657                  */
658                 if (ifr->ifr_flags & IFF_UP) {
659                         if (!(ifp->if_flags & IFF_RUNNING)) {
660                                 /* Sanity. */
661                                 if (b->fec_ifcnt == 1 || b->fec_ifcnt == 3) {
662                                         printf("fec%d: invalid bundle "
663                                             "size: %d\n", priv->unit,
664                                             b->fec_ifcnt);
665                                         error = EINVAL;
666                                         break;
667                                 }
668                                 ifp->if_flags &= ~(IFF_OACTIVE);
669                                 ifp->if_flags |= IFF_RUNNING;
670                                 ng_fec_init(ifp);
671                         }
672                         /*
673                          * Bubble down changes in promisc mode to
674                          * underlying interfaces.
675                          */
676                         if ((ifp->if_flags & IFF_PROMISC) !=
677                             (priv->if_flags & IFF_PROMISC)) {
678                                 ng_fec_setport(ifp, command, data);
679                                 priv->if_flags = ifp->if_flags;
680                         }
681                 } else {
682                         if (ifp->if_flags & IFF_RUNNING)
683                                 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
684                         ng_fec_stop(ifp);
685                 }
686                 break;
687
688         case SIOCADDMULTI:
689         case SIOCDELMULTI:
690                 ng_fec_setport(ifp, command, data);
691                 error = 0;
692                 break;
693         case SIOCGIFMEDIA:
694         case SIOCSIFMEDIA:
695                 error = ifmedia_ioctl(ifp, ifr, &priv->ifmedia, command);
696                 break;
697         /* Stuff that's not supported */
698         case SIOCSIFPHYS:
699                 error = EOPNOTSUPP;
700                 break;
701
702         default:
703                 error = EINVAL;
704                 break;
705         }
706         (void) splx(s);
707         return (error);
708 }
709
710 /*
711  * This routine spies on mbufs passing through ether_input(). If
712  * they come from one of the interfaces that are aggregated into
713  * our bundle, we fix up the ifnet pointer and increment our
714  * packet counters so that it looks like the frames are actually
715  * coming from us.
716  */
717 static void 
718 ng_fec_input(struct ifnet *ifp, struct mbuf **m0,
719                 struct ether_header *eh)
720 {
721         struct ng_node          *node;
722         struct ng_fec_private   *priv;
723         struct ng_fec_bundle    *b;
724         struct mbuf             *m;
725         struct ifnet            *bifp;
726         struct ng_fec_portlist  *p;
727
728         /* Sanity check */
729         if (ifp == NULL || m0 == NULL || eh == NULL)
730                 return;
731
732         node = IFP2NG(ifp);
733
734         /* Sanity check part II */
735         if (node == NULL)
736                 return;
737
738         priv = node->private;
739         b = &priv->fec_bundle;
740         bifp = &priv->arpcom.ac_if;
741
742         m = *m0;
743         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
744                 if (p->fec_if == m->m_pkthdr.rcvif)
745                         break;
746         }
747
748         /* Wasn't meant for us; leave this frame alone. */
749         if (p == NULL)
750                 return;
751
752         /* Pretend this is our frame. */
753         m->m_pkthdr.rcvif = bifp;
754         bifp->if_ipackets++;
755         bifp->if_ibytes += m->m_pkthdr.len + sizeof(struct ether_header);
756
757         /* Check for a BPF tap */
758         if (bifp->if_bpf != NULL) {
759                 struct m_hdr mh;
760
761                 /* This kludge is OK; BPF treats the "mbuf" as read-only */
762                 mh.mh_next = m;
763                 mh.mh_data = (char *)eh;
764                 mh.mh_len = ETHER_HDR_LEN;
765                 bpf_mtap(bifp, (struct mbuf *)&mh);
766         }
767
768         return;
769 }
770
771 /*
772  * Take a quick peek at the packet and see if it's ok for us to use
773  * the inet or inet6 hash methods on it, if they're enabled. We do
774  * this by setting flags in the mbuf header. Once we've made up our
775  * mind what to do, we pass the frame to ether_output() for further
776  * processing.
777  */
778
779 static int
780 ng_fec_output(struct ifnet *ifp, struct mbuf *m,
781                 struct sockaddr *dst, struct rtentry *rt0)
782 {
783         const priv_p priv = (priv_p) ifp->if_softc;
784         struct ng_fec_bundle *b;
785         int error;
786
787         /* Check interface flags */
788         if ((ifp->if_flags & (IFF_UP|IFF_RUNNING)) != (IFF_UP|IFF_RUNNING)) {
789                 m_freem(m);
790                 return (ENETDOWN);
791         }
792
793         b = &priv->fec_bundle;
794
795         switch (b->fec_btype) {
796         case FEC_BTYPE_MAC:
797                 m->m_flags |= M_FEC_MAC;
798                 break;
799 #ifdef INET
800         case FEC_BTYPE_INET:
801                 /*
802                  * We can't use the INET address port selection
803                  * scheme if this isn't an INET packet.
804                  */
805                 if (dst->sa_family == AF_INET)
806                         m->m_flags |= M_FEC_INET;
807 #ifdef INET6
808                 else if (dst->sa_family == AF_INET6)
809                         m->m_flags |= M_FEC_INET6;
810 #endif
811                 else {
812 #ifdef DEBUG
813                         printf("fec%d: can't do inet aggregation of non "
814                             "inet packet\n", ifp->if_unit);
815 #endif
816                         m->m_flags |= M_FEC_MAC;
817                 }
818                 break;
819 #endif
820         default:
821                 printf("fec%d: bogus hash type: %d\n", ifp->if_unit,
822                     b->fec_btype);
823                 m_freem(m);
824                 return(EINVAL);
825                 break;
826         }
827
828         /*
829          * Pass the frame to ether_output() for all the protocol
830          * handling. This will put the ethernet header on the packet
831          * for us.
832          */
833         priv->if_error = 0;
834         error = ether_output(ifp, m, dst, rt0);
835         if (priv->if_error && !error)
836                 error = priv->if_error;
837
838         return(error);
839 }
840
841 /*
842  * Apply a hash to the source and destination addresses in the packet
843  * in order to select an interface. Also check link status and handle
844  * dead links accordingly.
845  */
846
847 static int
848 ng_fec_choose_port(struct ng_fec_bundle *b,
849         struct mbuf *m, struct ifnet **ifp)
850 {
851         struct ether_header     *eh;
852         struct mbuf             *m0;
853 #ifdef INET
854         struct ip               *ip;
855 #ifdef INET6
856         struct ip6_hdr          *ip6;
857 #endif
858 #endif
859
860         struct ng_fec_portlist  *p;
861         int                     port = 0, mask;
862
863         /*
864          * If there are only two ports, mask off all but the
865          * last bit for XORing. If there are 4, mask off all
866          * but the last 2 bits.
867          */
868         mask = b->fec_ifcnt == 2 ? 0x1 : 0x3;
869         eh = mtod(m, struct ether_header *);
870 #ifdef INET
871         ip = (struct ip *)(mtod(m, char *) +
872             sizeof(struct ether_header));
873 #ifdef INET6
874         ip6 = (struct ip6_hdr *)(mtod(m, char *) +
875             sizeof(struct ether_header));
876 #endif
877 #endif
878
879         /*
880          * The fg_fec_output() routine is supposed to leave a
881          * flag for us in the mbuf that tells us what hash to
882          * use, but sometimes a new mbuf is prepended to the
883          * chain, so we have to search every mbuf in the chain
884          * to find the flags.
885          */
886         m0 = m;
887         while (m0) {
888                 if (m0->m_flags & (M_FEC_MAC|M_FEC_INET|M_FEC_INET6))
889                         break;
890                 m0 = m0->m_next;
891         }
892         if (m0 == NULL)
893                 return(EINVAL);
894
895         switch (m0->m_flags & (M_FEC_MAC|M_FEC_INET|M_FEC_INET6)) {
896         case M_FEC_MAC:
897                 port = (eh->ether_dhost[5] ^
898                     eh->ether_shost[5]) & mask;
899                 break;
900 #ifdef INET
901         case M_FEC_INET:
902                 port = (ntohl(ip->ip_dst.s_addr) ^
903                     ntohl(ip->ip_src.s_addr)) & mask;
904                 break;
905 #ifdef INET6
906         case M_FEC_INET6:
907                 port = (ip6->ip6_dst.s6_addr[15] ^
908                     ip6->ip6_dst.s6_addr[15]) & mask;
909                 break;
910 #endif
911 #endif
912         default:
913                 return(EINVAL);
914                         break;
915         }
916
917         TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
918                 if (port == p->fec_idx)
919                         break;
920         }
921
922         /*
923          * Now that we've chosen a port, make sure it's
924          * alive. If it's not alive, cycle through the bundle
925          * looking for a port that is alive. If we don't find
926          * any, return an error.
927          */
928         if (p->fec_ifstat != 1) {
929                 struct ng_fec_portlist  *n = NULL;
930
931                 n = TAILQ_NEXT(p, fec_list);
932                 if (n == NULL)
933                         n = TAILQ_FIRST(&b->ng_fec_ports);
934                 while (n != p) {
935                         if (n->fec_ifstat == 1)
936                                 break;
937                         n = TAILQ_NEXT(n, fec_list);
938                         if (n == NULL)
939                                 n = TAILQ_FIRST(&b->ng_fec_ports);
940                 }
941                 if (n == p)
942                         return(EAGAIN);
943                 p = n;
944         }
945
946         *ifp = p->fec_if;
947
948         return(0);
949 }
950
951 /*
952  * Now that the packet has been run through ether_output(), yank it
953  * off our own send queue and stick it on the queue for the appropriate
954  * underlying physical interface. Note that if the interface's send
955  * queue is full, we save an error status in our private netgraph
956  * space which will eventually be handed up to ng_fec_output(), which
957  * will return it to the rest of the IP stack. We need to do this
958  * in order to duplicate the effect of ether_output() returning ENOBUFS
959  * when it detects that an interface's send queue is full. There's no
960  * other way to signal the error status from here since the if_start()
961  * routine is spec'ed to return void.
962  *
963  * Once the frame is queued, we call ether_output_frame() to initiate
964  * transmission.
965  */
966 static void
967 ng_fec_start(struct ifnet *ifp)
968 {
969         struct ng_fec_private   *priv;
970         struct ng_fec_bundle    *b;
971         struct ifnet            *oifp = NULL;
972         struct mbuf             *m0;
973         int                     error;
974
975         priv = ifp->if_softc;
976         b = &priv->fec_bundle;
977
978         IF_DEQUEUE(&ifp->if_snd, m0);
979         if (m0 == NULL)
980                 return;
981
982         if (ifp->if_bpf)
983                 bpf_mtap(ifp, m0);
984
985         /* Queue up packet on the proper port. */
986         error = ng_fec_choose_port(b, m0, &oifp);
987         if (error) {
988                 ifp->if_ierrors++;
989                 m_freem(m0);
990                 priv->if_error = ENOBUFS;
991                 return;
992         }
993         ifp->if_opackets++;
994
995         priv->if_error = ether_output_frame(oifp, m0);
996         return;
997 }
998
999 #ifdef DEBUG
1000 /*
1001  * Display an ioctl to the virtual interface
1002  */
1003
1004 static void
1005 ng_fec_print_ioctl(struct ifnet *ifp, int command, caddr_t data)
1006 {
1007         char   *str;
1008
1009         switch (command & IOC_DIRMASK) {
1010         case IOC_VOID:
1011                 str = "IO";
1012                 break;
1013         case IOC_OUT:
1014                 str = "IOR";
1015                 break;
1016         case IOC_IN:
1017                 str = "IOW";
1018                 break;
1019         case IOC_INOUT:
1020                 str = "IORW";
1021                 break;
1022         default:
1023                 str = "IO??";
1024         }
1025         log(LOG_DEBUG, "%s%d: %s('%c', %d, char[%d])\n",
1026                ifp->if_name, ifp->if_unit,
1027                str,
1028                IOCGROUP(command),
1029                command & 0xff,
1030                IOCPARM_LEN(command));
1031 }
1032 #endif /* DEBUG */
1033
1034 /************************************************************************
1035                         NETGRAPH NODE STUFF
1036  ************************************************************************/
1037
1038 /*
1039  * Constructor for a node
1040  */
1041 static int
1042 ng_fec_constructor(node_p *nodep)
1043 {
1044         char ifname[NG_FEC_FEC_NAME_MAX + 1];
1045         struct ifnet *ifp;
1046         node_p node;
1047         priv_p priv;
1048         struct ng_fec_bundle *b;
1049         int error = 0;
1050
1051         /* Allocate node and interface private structures */
1052         MALLOC(priv, priv_p, sizeof(*priv), M_NETGRAPH, M_NOWAIT);
1053         if (priv == NULL)
1054                 return (ENOMEM);
1055         bzero(priv, sizeof(*priv));
1056
1057         ifp = &priv->arpcom.ac_if;
1058         b = &priv->fec_bundle;
1059
1060         /* Link them together */
1061         ifp->if_softc = priv;
1062
1063         /* Get an interface unit number */
1064         if ((error = ng_fec_get_unit(&priv->unit)) != 0) {
1065                 FREE(ifp, M_NETGRAPH);
1066                 FREE(priv, M_NETGRAPH);
1067                 return (error);
1068         }
1069
1070         /* Call generic node constructor */
1071         if ((error = ng_make_node_common(&typestruct, nodep)) != 0) {
1072                 ng_fec_free_unit(priv->unit);
1073                 FREE(ifp, M_NETGRAPH);
1074                 FREE(priv, M_NETGRAPH);
1075                 return (error);
1076         }
1077         node = *nodep;
1078
1079         /* Link together node and private info */
1080         node->private = priv;
1081         priv->node = node;
1082         priv->arpcom.ac_netgraph = node;
1083
1084         /* Initialize interface structure */
1085         ifp->if_name = NG_FEC_FEC_NAME;
1086         ifp->if_unit = 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         snprintf(ifname, sizeof(ifname), "%s%d", ifp->if_name, ifp->if_unit);
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, ETHER_BPF_SUPPORTED);
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%d",
1200                     p->fec_if->if_name,
1201                     p->fec_if->if_unit);
1202                 ng_fec_delport(priv, ifname);
1203         }
1204
1205         ng_cutlinks(node);
1206         ng_unname(node);
1207         if (ng_ether_input_p != NULL)
1208                 ng_ether_input_p = NULL;
1209         ether_ifdetach(&priv->arpcom.ac_if, ETHER_BPF_SUPPORTED);
1210         ifmedia_removeall(&priv->ifmedia);
1211         ng_fec_free_unit(priv->unit);
1212         FREE(priv, M_NETGRAPH);
1213         node->private = NULL;
1214         ng_unref(node);
1215         return (0);
1216 }