xref: /dragonfly/sys/netgraph/fec/ng_fec.c (revision 650094e1)
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  */
37 /*
38  * Copyright (c) 1996-1999 Whistle Communications, Inc.
39  * All rights reserved.
40  *
41  * Subject to the following obligations and disclaimer of warranty, use and
42  * redistribution of this software, in source or object code forms, with or
43  * without modifications are expressly permitted by Whistle Communications;
44  * provided, however, that:
45  * 1. Any and all reproductions of the source or object code must include the
46  *    copyright notice above and the following disclaimer of warranties; and
47  * 2. No rights are granted, in any manner or form, to use Whistle
48  *    Communications, Inc. trademarks, including the mark "WHISTLE
49  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
50  *    such appears in the above copyright notice or in the software.
51  *
52  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
53  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
54  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
55  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
56  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
57  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
58  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
59  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
60  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
61  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
62  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
63  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
64  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
65  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
66  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
67  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
68  * OF SUCH DAMAGE.
69  *
70  * Author: Archie Cobbs <archie@freebsd.org>
71  *
72  * $Whistle: ng_fec.c,v 1.33 1999/11/01 09:24:51 julian Exp $
73  */
74 
75 /*
76  * This module implements ethernet channel bonding using the Cisco
77  * Fast EtherChannel mechanism. Two or four ports may be combined
78  * into a single aggregate interface.
79  *
80  * Interfaces are named fec0, fec1, etc.  New nodes take the
81  * first available interface name.
82  *
83  * This node also includes Berkeley packet filter support.
84  *
85  * Note that this node doesn't need to connect to any other
86  * netgraph nodes in order to do its work.
87  */
88 
89 #include <sys/param.h>
90 #include <sys/systm.h>
91 #include <sys/errno.h>
92 #include <sys/kernel.h>
93 #include <sys/malloc.h>
94 #include <sys/mbuf.h>
95 #include <sys/errno.h>
96 #include <sys/sockio.h>
97 #include <sys/socket.h>
98 #include <sys/syslog.h>
99 #include <sys/libkern.h>
100 #include <sys/queue.h>
101 #include <sys/thread2.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/bpf.h>
109 #include <net/ethernet.h>
110 
111 #include "opt_inet.h"
112 #include "opt_inet6.h"
113 
114 #include <netinet/in.h>
115 #ifdef INET
116 #include <netinet/in_systm.h>
117 #include <netinet/ip.h>
118 #endif
119 
120 #ifdef INET6
121 #include <netinet/ip6.h>
122 #endif
123 
124 #include <netgraph/ng_message.h>
125 #include <netgraph/netgraph.h>
126 #include <netgraph/ng_parse.h>
127 #include "ng_fec.h"
128 
129 #define IFP2NG(ifp)  ((struct ng_node *)((struct arpcom *)(ifp))->ac_netgraph)
130 #define FEC_INC(x, y)	(x) = (x + 1) % y
131 
132 /*
133  * Current fast etherchannel implementations use either 2 or 4
134  * ports, so for now we limit the maximum bundle size to 4 interfaces.
135  */
136 #define FEC_BUNDLESIZ	4
137 
138 struct ng_fec_portlist {
139 	struct ifnet		*fec_if;
140 	int			fec_idx;
141 	int			fec_ifstat;
142 	struct ether_addr	fec_mac;
143 	TAILQ_ENTRY(ng_fec_portlist) fec_list;
144 };
145 
146 struct ng_fec_bundle {
147 	TAILQ_HEAD(,ng_fec_portlist) ng_fec_ports;
148 	int			fec_ifcnt;
149 	int			fec_btype;
150 };
151 
152 #define FEC_BTYPE_MAC		0x01
153 #define FEC_BTYPE_INET		0x02
154 #define FEC_BTYPE_INET6		0x03
155 
156 /* Node private data */
157 struct ng_fec_private {
158 	struct arpcom arpcom;
159 	struct ifmedia ifmedia;
160 	int	if_flags;
161 	int	if_error;		/* XXX */
162 	int	unit;			/* Interface unit number */
163 	node_p	node;			/* Our netgraph node */
164 	struct ng_fec_bundle fec_bundle;/* Aggregate bundle */
165 	struct callout fec_timeout;	/* callout for ticker */
166 	int	(*real_if_output)(struct ifnet *, struct mbuf *,
167 				  struct sockaddr *, struct rtentry *);
168 };
169 typedef struct ng_fec_private *priv_p;
170 
171 /* Interface methods */
172 static void	ng_fec_input(struct ifnet *, struct mbuf **);
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 		newarray = kmalloc(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 			kfree(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", __func__, 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", __func__, unit, ng_fec_units_len));
306 	KASSERT((ng_fec_units[index] & (1 << bit)) == 0,
307 	    ("%s: unit=%d is free", __func__, 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 		kfree(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 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 		kprintf("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 		kprintf("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 			kprintf("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 	new = kmalloc(sizeof(struct ng_fec_portlist), M_NETGRAPH, M_NOWAIT);
368 	if (new == NULL)
369 		return(ENOMEM);
370 
371 	ac = (struct arpcom *)bifp;
372 	ac->ac_netgraph = priv->node;
373 
374 	/*
375 	 * If this is the first interface added to the bundle,
376 	 * use its MAC address for the virtual interface (and,
377 	 * by extension, all the other ports in the bundle).
378 	 */
379 	if (b->fec_ifcnt == 0) {
380 		sdl = IF_LLSOCKADDR(ifp);
381 		bcopy((char *)ac->ac_enaddr,
382 		    priv->arpcom.ac_enaddr, ETHER_ADDR_LEN);
383 		bcopy((char *)ac->ac_enaddr,
384 		    LLADDR(sdl), ETHER_ADDR_LEN);
385 	}
386 
387 	b->fec_btype = FEC_BTYPE_MAC;
388 	new->fec_idx = b->fec_ifcnt;
389 	b->fec_ifcnt++;
390 
391 	/* Save the real MAC address. */
392 	bcopy((char *)ac->ac_enaddr,
393 	    (char *)&new->fec_mac, ETHER_ADDR_LEN);
394 
395 	/* Set up phony MAC address. */
396 	sdl = IF_LLSOCKADDR(bifp);
397 	bcopy(priv->arpcom.ac_enaddr, ac->ac_enaddr, ETHER_ADDR_LEN);
398 	bcopy(priv->arpcom.ac_enaddr, LLADDR(sdl), ETHER_ADDR_LEN);
399 
400 	/* Add to the queue */
401 	new->fec_if = bifp;
402 	TAILQ_INSERT_TAIL(&b->ng_fec_ports, new, fec_list);
403 
404 	return(0);
405 }
406 
407 static int
408 ng_fec_delport(struct ng_fec_private *priv, char *iface)
409 {
410 	struct ng_fec_bundle	*b;
411 	struct ifnet		*ifp, *bifp;
412 	struct arpcom		*ac;
413 	struct sockaddr_dl	*sdl;
414 	struct ng_fec_portlist	*p;
415 
416 	if (priv == NULL || iface == NULL)
417 		return(EINVAL);
418 
419 	b = &priv->fec_bundle;
420 	ifp = &priv->arpcom.ac_if;
421 
422 	/* Find the interface */
423 	bifp = ifunit(iface);
424 	if (bifp == NULL) {
425 		kprintf("fec%d: tried to remove iface %s, which "
426 		    "doesn't seem to exist\n", priv->unit, iface);
427 		return(ENOENT);
428 	}
429 
430 	TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
431 		if (p->fec_if == bifp)
432 			break;
433 	}
434 
435 	if (p == NULL) {
436 		kprintf("fec%d: tried to remove iface %s which "
437 		    "is not in our bundle\n", priv->unit, iface);
438 		return(EINVAL);
439 	}
440 
441 	/* Stop interface */
442 	bifp->if_flags &= ~IFF_UP;
443 	bifp->if_ioctl(bifp, SIOCSIFFLAGS, NULL, NULL);
444 
445 	/* Restore MAC address. */
446 	ac = (struct arpcom *)bifp;
447 	sdl = IF_LLSOCKADDR(bifp);
448 	bcopy((char *)&p->fec_mac, ac->ac_enaddr, ETHER_ADDR_LEN);
449 	bcopy((char *)&p->fec_mac, LLADDR(sdl), ETHER_ADDR_LEN);
450 
451 	/* Delete port */
452 	TAILQ_REMOVE(&b->ng_fec_ports, p, fec_list);
453 	kfree(p, M_NETGRAPH);
454 	b->fec_ifcnt--;
455 
456 	return(0);
457 }
458 
459 /*
460  * Pass an ioctl command down to all the underyling interfaces in a
461  * bundle. Used for setting multicast filters and flags.
462  */
463 static int
464 ng_fec_setport(struct ifnet *ifp, u_long command, caddr_t data)
465 {
466 	struct ng_fec_private	*priv;
467 	struct ng_fec_bundle	*b;
468 	struct ifnet		*oifp;
469 	struct ng_fec_portlist	*p;
470 
471 	priv = ifp->if_softc;
472 	b = &priv->fec_bundle;
473 
474 	ifnet_deserialize_all(ifp);	/* XXX */
475 	TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
476 		oifp = p->fec_if;
477 		if (oifp != NULL) {
478 			ifnet_serialize_all(oifp);
479 			oifp->if_ioctl(oifp, command, data, NULL);
480 			ifnet_deserialize_all(oifp);
481 		}
482 	}
483 	ifnet_serialize_all(ifp);
484 
485 	return(0);
486 }
487 
488 static void
489 ng_fec_init(void *arg)
490 {
491 	struct ng_fec_private	*priv;
492 	struct ng_fec_bundle	*b;
493 	struct ifnet		*ifp, *bifp;
494 	struct ng_fec_portlist	*p;
495 
496 	ifp = arg;
497 	priv = ifp->if_softc;
498 	b = &priv->fec_bundle;
499 
500 	if (b->fec_ifcnt == 1 || b->fec_ifcnt == 3) {
501 		kprintf("fec%d: invalid bundle "
502 		    "size: %d\n", priv->unit,
503 		    b->fec_ifcnt);
504 		return;
505 	}
506 
507 	ng_fec_stop(ifp);
508 
509 	ifnet_deserialize_all(ifp);	/* XXX */
510 	TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
511 		bifp = p->fec_if;
512 		ifnet_serialize_all(bifp);
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 		ifnet_deserialize_all(bifp);
518 	}
519 	ifnet_serialize_all(ifp);
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 	ifnet_deserialize_all(ifp);	/* XXX */
536 	TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
537 		bifp = p->fec_if;
538 		ifnet_serialize_all(bifp);
539 		bifp->if_flags &= ~IFF_UP;
540                 bifp->if_ioctl(bifp, SIOCSIFFLAGS, NULL, NULL);
541 		ifnet_deserialize_all(bifp);
542 	}
543 	ifnet_serialize_all(ifp);
544 
545 	callout_stop(&priv->fec_timeout);
546 }
547 
548 static void
549 ng_fec_tick(void *arg)
550 {
551 	struct ng_fec_private	*priv;
552 	struct ng_fec_bundle	*b;
553         struct ifmediareq	ifmr;
554 	struct ifnet		*ifp;
555 	struct ng_fec_portlist	*p;
556 	int			error = 0;
557 
558 	priv = arg;
559 	b = &priv->fec_bundle;
560 
561 	/*
562 	 * Note: serializer for parent interface not held on entry, and
563 	 * cannot be held during the loop to avoid a deadlock.
564 	 */
565 	TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
566 		bzero((char *)&ifmr, sizeof(ifmr));
567 		ifp = p->fec_if;
568 		ifnet_serialize_all(ifp);
569 		error = ifp->if_ioctl(ifp, SIOCGIFMEDIA, (caddr_t)&ifmr, NULL);
570 		if (error) {
571 			kprintf("fec%d: failed to check status "
572 			    "of link %s\n", priv->unit, ifp->if_xname);
573 			ifnet_deserialize_all(ifp);
574 			continue;
575 		}
576 
577         	if (ifmr.ifm_status & IFM_AVALID &&
578                     IFM_TYPE(ifmr.ifm_active) == IFM_ETHER) {
579 			if (ifmr.ifm_status & IFM_ACTIVE) {
580 				if (p->fec_ifstat == -1 ||
581 				    p->fec_ifstat == 0) {
582 					p->fec_ifstat = 1;
583 					kprintf("fec%d: port %s in bundle "
584 					    "is up\n", priv->unit,
585 					    ifp->if_xname);
586 				}
587 			} else {
588 				if (p->fec_ifstat == -1 ||
589 				    p->fec_ifstat == 1) {
590 					p->fec_ifstat = 0;
591 					kprintf("fec%d: port %s in bundle "
592 					    "is down\n", priv->unit,
593 					    ifp->if_xname);
594 				}
595 			}
596 		}
597 		ifnet_deserialize_all(ifp);
598 	}
599 
600 	ifp = &priv->arpcom.ac_if;
601 	if (ifp->if_flags & IFF_RUNNING)
602 		callout_reset(&priv->fec_timeout, hz, ng_fec_tick, priv);
603 }
604 
605 static int
606 ng_fec_ifmedia_upd(struct ifnet *ifp)
607 {
608 	return(0);
609 }
610 
611 static void
612 ng_fec_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr)
613 {
614 	struct ng_fec_private	*priv;
615 	struct ng_fec_bundle	*b;
616 	struct ng_fec_portlist	*p;
617 
618 	priv = ifp->if_softc;
619 	b = &priv->fec_bundle;
620 
621 	ifmr->ifm_status = IFM_AVALID;
622 	TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
623 		if (p->fec_ifstat) {
624 			ifmr->ifm_status |= IFM_ACTIVE;
625 			break;
626 		}
627 	}
628 }
629 
630 /*
631  * Process an ioctl for the virtual interface
632  */
633 static int
634 ng_fec_ioctl(struct ifnet *ifp, u_long command, caddr_t data, struct ucred *cr)
635 {
636 	struct ifreq *const ifr = (struct ifreq *) data;
637 	int error = 0;
638 	struct ng_fec_private	*priv;
639 	struct ng_fec_bundle	*b;
640 
641 	priv = ifp->if_softc;
642 	b = &priv->fec_bundle;
643 
644 #ifdef DEBUG
645 	ng_fec_print_ioctl(ifp, command, data);
646 #endif
647 	crit_enter();
648 	switch (command) {
649 
650 	/* These two are mostly handled at a higher layer */
651 	case SIOCSIFADDR:
652 	case SIOCGIFADDR:
653 	case SIOCSIFMTU:
654 		error = ether_ioctl(ifp, command, data);
655 		break;
656 
657 	/* Set flags */
658 	case SIOCSIFFLAGS:
659 		/*
660 		 * If the interface is marked up and stopped, then start it.
661 		 * If it is marked down and running, then stop it.
662 		 */
663 		if (ifr->ifr_flags & IFF_UP) {
664 			if (!(ifp->if_flags & IFF_RUNNING)) {
665 				/* Sanity. */
666 				if (b->fec_ifcnt == 1 || b->fec_ifcnt == 3) {
667 					kprintf("fec%d: invalid bundle "
668 					    "size: %d\n", priv->unit,
669 					    b->fec_ifcnt);
670 					error = EINVAL;
671 					break;
672 				}
673 				ifp->if_flags &= ~(IFF_OACTIVE);
674 				ifp->if_flags |= IFF_RUNNING;
675 				ng_fec_init(ifp);
676 			}
677 			/*
678 			 * Bubble down changes in promisc mode to
679 			 * underlying interfaces.
680 			 */
681 			if ((ifp->if_flags & IFF_PROMISC) !=
682 			    (priv->if_flags & IFF_PROMISC)) {
683 				ng_fec_setport(ifp, command, data);
684 				priv->if_flags = ifp->if_flags;
685 			}
686 		} else {
687 			if (ifp->if_flags & IFF_RUNNING)
688 				ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
689 			ng_fec_stop(ifp);
690 		}
691 		break;
692 
693 	case SIOCADDMULTI:
694 	case SIOCDELMULTI:
695 		ng_fec_setport(ifp, command, data);
696 		error = 0;
697 		break;
698 	case SIOCGIFMEDIA:
699 	case SIOCSIFMEDIA:
700 		error = ifmedia_ioctl(ifp, ifr, &priv->ifmedia, command);
701 		break;
702 	/* Stuff that's not supported */
703 	case SIOCSIFPHYS:
704 		error = EOPNOTSUPP;
705 		break;
706 
707 	default:
708 		error = EINVAL;
709 		break;
710 	}
711 	crit_exit();
712 	return (error);
713 }
714 
715 /*
716  * This routine spies on mbufs passing through ether_input(). If
717  * they come from one of the interfaces that are aggregated into
718  * our bundle, we fix up the ifnet pointer and increment our
719  * packet counters so that it looks like the frames are actually
720  * coming from us.
721  */
722 static void
723 ng_fec_input(struct ifnet *ifp, struct mbuf **m0)
724 {
725 	struct ng_node		*node;
726 	struct ng_fec_private	*priv;
727 	struct ng_fec_bundle	*b;
728 	struct mbuf		*m;
729 	struct ifnet		*bifp;
730 	struct ng_fec_portlist	*p;
731 
732 	/* Sanity check */
733 	if (ifp == NULL || m0 == NULL)
734 		return;
735 
736 	node = IFP2NG(ifp);
737 
738 	/* Sanity check part II */
739 	if (node == NULL)
740 		return;
741 
742 	priv = node->private;
743 	b = &priv->fec_bundle;
744 	bifp = &priv->arpcom.ac_if;
745 
746 	m = *m0;
747 	TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
748 		if (p->fec_if == m->m_pkthdr.rcvif)
749 			break;
750 	}
751 
752 	/* Wasn't meant for us; leave this frame alone. */
753 	if (p == NULL)
754 		return;
755 
756 	/* Pretend this is our frame. */
757 	m->m_pkthdr.rcvif = bifp;
758 	bifp->if_ipackets++;
759 	bifp->if_ibytes += m->m_pkthdr.len;
760 
761 	if (bifp->if_bpf)
762 		bpf_mtap(bifp->if_bpf, m);
763 }
764 
765 /*
766  * Take a quick peek at the packet and see if it's ok for us to use
767  * the inet or inet6 hash methods on it, if they're enabled. We do
768  * this by setting flags in the mbuf header. Once we've made up our
769  * mind what to do, we pass the frame to ether_output() for further
770  * processing.
771  */
772 
773 static int
774 ng_fec_output_serialized(struct ifnet *ifp, struct mbuf *m,
775 			 struct sockaddr *dst, struct rtentry *rt0)
776 {
777 	const priv_p priv = (priv_p) ifp->if_softc;
778 	struct ng_fec_bundle *b;
779 	int error;
780 
781 	/* Check interface flags */
782 	if ((ifp->if_flags & (IFF_UP|IFF_RUNNING)) != (IFF_UP|IFF_RUNNING)) {
783 		m_freem(m);
784 		return (ENETDOWN);
785 	}
786 
787 	b = &priv->fec_bundle;
788 
789 	switch (b->fec_btype) {
790 	case FEC_BTYPE_MAC:
791 		m->m_flags |= M_FEC_MAC;
792 		break;
793 #ifdef INET
794 	case FEC_BTYPE_INET:
795 		/*
796 		 * We can't use the INET address port selection
797 		 * scheme if this isn't an INET packet.
798 		 */
799 		if (dst->sa_family == AF_INET)
800 			m->m_flags |= M_FEC_INET;
801 #ifdef INET6
802 		else if (dst->sa_family == AF_INET6)
803 			m->m_flags |= M_FEC_INET6;
804 #endif
805 		else {
806 #ifdef DEBUG
807 			kprintf("%s: can't do inet aggregation of non "
808 			    "inet packet\n", ifp->if_xname);
809 #endif
810 			m->m_flags |= M_FEC_MAC;
811 		}
812 		break;
813 #endif
814 	default:
815 		kprintf("%s: bogus hash type: %d\n", ifp->if_xname,
816 		    b->fec_btype);
817 		m_freem(m);
818 		return(EINVAL);
819 		break;
820 	}
821 
822 	/*
823 	 * Pass the frame to ether_output() for all the protocol
824 	 * handling. This will put the ethernet header on the packet
825 	 * for us.
826 	 */
827 	priv->if_error = 0;
828 	error = priv->real_if_output(ifp, m, dst, rt0);
829 	if (priv->if_error && !error)
830 		error = priv->if_error;
831 
832 	return(error);
833 }
834 
835 static int
836 ng_fec_output(struct ifnet *ifp, struct mbuf *m,
837 	      struct sockaddr *dst, struct rtentry *rt0)
838 {
839 	int error;
840 
841 	ifnet_serialize_tx(ifp);
842 	error = ng_fec_output_serialized(ifp, m, dst, rt0);
843 	ifnet_deserialize_tx(ifp);
844 
845 	return error;
846 }
847 
848 /*
849  * Apply a hash to the source and destination addresses in the packet
850  * in order to select an interface. Also check link status and handle
851  * dead links accordingly.
852  */
853 
854 static int
855 ng_fec_choose_port(struct ng_fec_bundle *b,
856 	struct mbuf *m, struct ifnet **ifp)
857 {
858 	struct ether_header	*eh;
859 	struct mbuf		*m0;
860 #ifdef INET
861 	struct ip		*ip;
862 #ifdef INET6
863 	struct ip6_hdr		*ip6;
864 #endif
865 #endif
866 
867 	struct ng_fec_portlist	*p;
868 	int			port = 0, mask;
869 
870 	/*
871 	 * If there are only two ports, mask off all but the
872 	 * last bit for XORing. If there are 4, mask off all
873 	 * but the last 2 bits.
874 	 */
875 	mask = b->fec_ifcnt == 2 ? 0x1 : 0x3;
876 	eh = mtod(m, struct ether_header *);
877 #ifdef INET
878 	ip = (struct ip *)(mtod(m, char *) +
879 	    sizeof(struct ether_header));
880 #ifdef INET6
881 	ip6 = (struct ip6_hdr *)(mtod(m, char *) +
882 	    sizeof(struct ether_header));
883 #endif
884 #endif
885 
886 	/*
887 	 * The fg_fec_output() routine is supposed to leave a
888 	 * flag for us in the mbuf that tells us what hash to
889 	 * use, but sometimes a new mbuf is prepended to the
890 	 * chain, so we have to search every mbuf in the chain
891 	 * to find the flags.
892 	 */
893 	m0 = m;
894 	while (m0) {
895 		if (m0->m_flags & (M_FEC_MAC|M_FEC_INET|M_FEC_INET6))
896 			break;
897 		m0 = m0->m_next;
898 	}
899 	if (m0 == NULL)
900 		return(EINVAL);
901 
902 	switch (m0->m_flags & (M_FEC_MAC|M_FEC_INET|M_FEC_INET6)) {
903 	case M_FEC_MAC:
904 		port = (eh->ether_dhost[5] ^
905 		    eh->ether_shost[5]) & mask;
906 		break;
907 #ifdef INET
908 	case M_FEC_INET:
909 		port = (ntohl(ip->ip_dst.s_addr) ^
910 		    ntohl(ip->ip_src.s_addr)) & mask;
911 		break;
912 #ifdef INET6
913 	case M_FEC_INET6:
914 		port = (ip6->ip6_dst.s6_addr[15] ^
915 		    ip6->ip6_dst.s6_addr[15]) & mask;
916 		break;
917 #endif
918 #endif
919 	default:
920 		return(EINVAL);
921 			break;
922 	}
923 
924 	TAILQ_FOREACH(p, &b->ng_fec_ports, fec_list) {
925 		if (port == p->fec_idx)
926 			break;
927 	}
928 
929 	/*
930 	 * Now that we've chosen a port, make sure it's
931 	 * alive. If it's not alive, cycle through the bundle
932 	 * looking for a port that is alive. If we don't find
933 	 * any, return an error.
934 	 */
935 	if (p->fec_ifstat != 1) {
936 		struct ng_fec_portlist	*n = NULL;
937 
938 		n = TAILQ_NEXT(p, fec_list);
939 		if (n == NULL)
940 			n = TAILQ_FIRST(&b->ng_fec_ports);
941 		while (n != p) {
942 			if (n->fec_ifstat == 1)
943 				break;
944 			n = TAILQ_NEXT(n, fec_list);
945 			if (n == NULL)
946 				n = TAILQ_FIRST(&b->ng_fec_ports);
947 		}
948 		if (n == p)
949 			return(EAGAIN);
950 		p = n;
951 	}
952 
953 	*ifp = p->fec_if;
954 
955 	return(0);
956 }
957 
958 /*
959  * Now that the packet has been run through ether_output(), yank it
960  * off our own send queue and stick it on the queue for the appropriate
961  * underlying physical interface. Note that if the interface's send
962  * queue is full, we save an error status in our private netgraph
963  * space which will eventually be handed up to ng_fec_output(), which
964  * will return it to the rest of the IP stack. We need to do this
965  * in order to duplicate the effect of ether_output() returning ENOBUFS
966  * when it detects that an interface's send queue is full. There's no
967  * other way to signal the error status from here since the if_start()
968  * routine is spec'ed to return void.
969  *
970  * Once the frame is queued, we call ether_output_frame() to initiate
971  * transmission.
972  */
973 static void
974 ng_fec_start(struct ifnet *ifp)
975 {
976 	struct ng_fec_private	*priv;
977 	struct ng_fec_bundle	*b;
978 	struct ifnet		*oifp = NULL;
979 	struct mbuf		*m0;
980 	int			error;
981 
982 	priv = ifp->if_softc;
983 	b = &priv->fec_bundle;
984 
985 	IF_DEQUEUE(&ifp->if_snd, m0);
986 	if (m0 == NULL)
987 		return;
988 
989 	BPF_MTAP(ifp, m0);
990 
991 	/* Queue up packet on the proper port. */
992 	error = ng_fec_choose_port(b, m0, &oifp);
993 	if (error) {
994 		ifp->if_ierrors++;
995 		m_freem(m0);
996 		priv->if_error = ENOBUFS;
997 		return;
998 	}
999 	ifp->if_opackets++;
1000 
1001 	/*
1002 	 * Release current iface's serializer to avoid possible dead lock
1003 	 */
1004 	priv->if_error = ether_output_frame(oifp, m0);
1005 }
1006 
1007 #ifdef DEBUG
1008 /*
1009  * Display an ioctl to the virtual interface
1010  */
1011 
1012 static void
1013 ng_fec_print_ioctl(struct ifnet *ifp, int command, caddr_t data)
1014 {
1015 	char   *str;
1016 
1017 	switch (command & IOC_DIRMASK) {
1018 	case IOC_VOID:
1019 		str = "IO";
1020 		break;
1021 	case IOC_OUT:
1022 		str = "IOR";
1023 		break;
1024 	case IOC_IN:
1025 		str = "IOW";
1026 		break;
1027 	case IOC_INOUT:
1028 		str = "IORW";
1029 		break;
1030 	default:
1031 		str = "IO??";
1032 	}
1033 	log(LOG_DEBUG, "%s: %s('%c', %d, char[%d])\n",
1034 	       ifp->if_xname,
1035 	       str,
1036 	       IOCGROUP(command),
1037 	       command & 0xff,
1038 	       IOCPARM_LEN(command));
1039 }
1040 #endif /* DEBUG */
1041 
1042 /************************************************************************
1043 			NETGRAPH NODE STUFF
1044  ************************************************************************/
1045 
1046 /*
1047  * Constructor for a node
1048  */
1049 static int
1050 ng_fec_constructor(node_p *nodep)
1051 {
1052 	char ifname[NG_FEC_FEC_NAME_MAX + 1];
1053 	struct ifnet *ifp;
1054 	node_p node;
1055 	priv_p priv;
1056 	struct ng_fec_bundle *b;
1057 	int error = 0;
1058 
1059 	/* Allocate node and interface private structures */
1060 	priv = kmalloc(sizeof(*priv), M_NETGRAPH, M_NOWAIT | M_ZERO);
1061 	if (priv == NULL)
1062 		return (ENOMEM);
1063 
1064 	ifp = &priv->arpcom.ac_if;
1065 	b = &priv->fec_bundle;
1066 
1067 	/* Link them together */
1068 	ifp->if_softc = priv;
1069 
1070 	/* Get an interface unit number */
1071 	if ((error = ng_fec_get_unit(&priv->unit)) != 0) {
1072 		kfree(ifp, M_NETGRAPH);
1073 		kfree(priv, M_NETGRAPH);
1074 		return (error);
1075 	}
1076 
1077 	/* Call generic node constructor */
1078 	if ((error = ng_make_node_common(&typestruct, nodep)) != 0) {
1079 		ng_fec_free_unit(priv->unit);
1080 		kfree(ifp, M_NETGRAPH);
1081 		kfree(priv, M_NETGRAPH);
1082 		return (error);
1083 	}
1084 	node = *nodep;
1085 
1086 	/* Link together node and private info */
1087 	node->private = priv;
1088 	priv->node = node;
1089 	priv->arpcom.ac_netgraph = node;
1090 
1091 	/* Initialize interface structure */
1092 	if_initname(ifp, NG_FEC_FEC_NAME, priv->unit);
1093 	ifp->if_start = ng_fec_start;
1094 	ifp->if_ioctl = ng_fec_ioctl;
1095 	ifp->if_init = ng_fec_init;
1096 	ifp->if_watchdog = NULL;
1097 	ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
1098 	ifp->if_mtu = NG_FEC_MTU_DEFAULT;
1099 	ifp->if_flags = (IFF_SIMPLEX|IFF_BROADCAST|IFF_MULTICAST);
1100 	ifp->if_type = IFT_PROPVIRTUAL;		/* XXX */
1101 	ifp->if_addrlen = 0;			/* XXX */
1102 	ifp->if_hdrlen = 0;			/* XXX */
1103 	ifp->if_baudrate = 100000000;		/* XXX */
1104 
1105 	/* Give this node the same name as the interface (if possible) */
1106 	bzero(ifname, sizeof(ifname));
1107 	strlcpy(ifname, ifp->if_xname, sizeof(ifname));
1108 	if (ng_name_node(node, ifname) != 0)
1109 		log(LOG_WARNING, "%s: can't acquire netgraph name\n", ifname);
1110 
1111 	/* Grab hold of the ether_input pipe. */
1112 	if (ng_ether_input_p == NULL)
1113 		ng_ether_input_p = ng_fec_input;
1114 
1115 	/* Attach the interface */
1116 	ether_ifattach(ifp, priv->arpcom.ac_enaddr, NULL);
1117 	priv->real_if_output = ifp->if_output;
1118 	ifp->if_output = ng_fec_output;
1119 	callout_init(&priv->fec_timeout);
1120 
1121 	TAILQ_INIT(&b->ng_fec_ports);
1122 	b->fec_ifcnt = 0;
1123 
1124 	ifmedia_init(&priv->ifmedia, 0,
1125 	    ng_fec_ifmedia_upd, ng_fec_ifmedia_sts);
1126 	ifmedia_add(&priv->ifmedia, IFM_ETHER|IFM_NONE, 0, NULL);
1127 	ifmedia_set(&priv->ifmedia, IFM_ETHER|IFM_NONE);
1128 
1129 	/* Done */
1130 	return (0);
1131 }
1132 
1133 /*
1134  * Receive a control message
1135  */
1136 static int
1137 ng_fec_rcvmsg(node_p node, struct ng_mesg *msg,
1138 		const char *retaddr, struct ng_mesg **rptr)
1139 {
1140 	const priv_p priv = node->private;
1141 	struct ng_fec_bundle	*b;
1142 	struct ng_mesg *resp = NULL;
1143 	char *ifname;
1144 	int error = 0;
1145 
1146 	b = &priv->fec_bundle;
1147 
1148 	switch (msg->header.typecookie) {
1149 	case NGM_FEC_COOKIE:
1150 		switch (msg->header.cmd) {
1151 		case NGM_FEC_ADD_IFACE:
1152 			ifname = msg->data;
1153 			error = ng_fec_addport(priv, ifname);
1154 			break;
1155 		case NGM_FEC_DEL_IFACE:
1156 			ifname = msg->data;
1157 			error = ng_fec_delport(priv, ifname);
1158 			break;
1159 		case NGM_FEC_SET_MODE_MAC:
1160 			b->fec_btype = FEC_BTYPE_MAC;
1161 			break;
1162 #ifdef INET
1163 		case NGM_FEC_SET_MODE_INET:
1164 			b->fec_btype = FEC_BTYPE_INET;
1165 			break;
1166 #ifdef INET6
1167 		case NGM_FEC_SET_MODE_INET6:
1168 			b->fec_btype = FEC_BTYPE_INET6;
1169 			break;
1170 #endif
1171 #endif
1172 		default:
1173 			error = EINVAL;
1174 			break;
1175 		}
1176 		break;
1177 	default:
1178 		error = EINVAL;
1179 		break;
1180 	}
1181 	if (rptr)
1182 		*rptr = resp;
1183 	else if (resp)
1184 		kfree(resp, M_NETGRAPH);
1185 	kfree(msg, M_NETGRAPH);
1186 	return (error);
1187 }
1188 
1189 /*
1190  * Shutdown and remove the node and its associated interface.
1191  */
1192 static int
1193 ng_fec_rmnode(node_p node)
1194 {
1195 	const priv_p priv = node->private;
1196 	struct ng_fec_bundle *b;
1197 	struct ng_fec_portlist	*p;
1198 	char ifname[IFNAMSIZ];
1199 
1200 	b = &priv->fec_bundle;
1201 	ng_fec_stop(&priv->arpcom.ac_if);
1202 
1203 	while (!TAILQ_EMPTY(&b->ng_fec_ports)) {
1204 		p = TAILQ_FIRST(&b->ng_fec_ports);
1205 		ksprintf(ifname, "%s",
1206 		    p->fec_if->if_xname); /* XXX: strings */
1207 		ng_fec_delport(priv, ifname);
1208 	}
1209 
1210 	ng_cutlinks(node);
1211 	ng_unname(node);
1212 	if (ng_ether_input_p != NULL)
1213 		ng_ether_input_p = NULL;
1214 	ether_ifdetach(&priv->arpcom.ac_if);
1215 	ifmedia_removeall(&priv->ifmedia);
1216 	ng_fec_free_unit(priv->unit);
1217 	kfree(priv, M_NETGRAPH);
1218 	node->private = NULL;
1219 	ng_unref(node);
1220 	return (0);
1221 }
1222