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