5 * Copyright (c) 1996-2000 Whistle Communications, Inc.
8 * Subject to the following obligations and disclaimer of warranty, use and
9 * redistribution of this software, in source or object code forms, with or
10 * without modifications are expressly permitted by Whistle Communications;
11 * provided, however, that:
12 * 1. Any and all reproductions of the source or object code must include the
13 * copyright notice above and the following disclaimer of warranties; and
14 * 2. No rights are granted, in any manner or form, to use Whistle
15 * Communications, Inc. trademarks, including the mark "WHISTLE
16 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
17 * such appears in the above copyright notice or in the software.
19 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
20 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
21 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
22 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
23 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
24 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
25 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
26 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
27 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
28 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
29 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
30 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
31 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
37 * Authors: Archie Cobbs <archie@freebsd.org>
38 * Julian Elischer <julian@freebsd.org>
40 * $FreeBSD: src/sys/netgraph/ng_ether.c,v 1.2.2.13 2002/07/02 20:10:25 archie Exp $
41 * $DragonFly: src/sys/netgraph/ether/ng_ether.c,v 1.16 2008/05/28 12:11:13 sephe Exp $
45 * ng_ether(4) netgraph node type
48 #include <sys/param.h>
49 #include <sys/systm.h>
50 #include <sys/kernel.h>
51 #include <sys/malloc.h>
53 #include <sys/errno.h>
54 #include <sys/syslog.h>
55 #include <sys/socket.h>
56 #include <sys/thread2.h>
59 #include <net/if_types.h>
60 #include <net/if_arp.h>
61 #include <net/if_var.h>
62 #include <net/ethernet.h>
64 #include <netgraph/ng_message.h>
65 #include <netgraph/netgraph.h>
66 #include <netgraph/ng_parse.h>
69 #define IFP2AC(IFP) ((struct arpcom *)IFP)
70 #define IFP2NG(ifp) (IFP2AC((ifp))->ac_netgraph)
72 /* Per-node private data */
74 struct ifnet *ifp; /* associated interface */
75 hook_p upper; /* upper hook connection */
76 hook_p lower; /* lower OR orphan hook connection */
77 u_char lowerOrphan; /* whether lower is lower or orphan */
78 u_char autoSrcAddr; /* always overwrite source address */
79 u_char promisc; /* promiscuous mode enabled */
80 u_long hwassist; /* hardware checksum capabilities */
82 typedef struct private *priv_p;
84 /* Functional hooks called from if_ethersubr.c */
85 static void ng_ether_input(struct ifnet *ifp, struct mbuf **mp);
86 static void ng_ether_input_orphan(struct ifnet *ifp,
87 struct mbuf *m, const struct ether_header *eh);
88 static int ng_ether_output(struct ifnet *ifp, struct mbuf **mp);
89 static void ng_ether_attach(struct ifnet *ifp);
90 static void ng_ether_detach(struct ifnet *ifp);
93 static void ng_ether_input2(node_p node,
94 struct mbuf **mp, const struct ether_header *eh);
95 static int ng_ether_glueback_header(struct mbuf **mp,
96 const struct ether_header *eh);
97 static int ng_ether_rcv_lower(node_p node, struct mbuf *m, meta_p meta);
98 static int ng_ether_rcv_upper(node_p node, struct mbuf *m, meta_p meta);
100 /* Netgraph node methods */
101 static ng_constructor_t ng_ether_constructor;
102 static ng_rcvmsg_t ng_ether_rcvmsg;
103 static ng_shutdown_t ng_ether_rmnode;
104 static ng_newhook_t ng_ether_newhook;
105 static ng_rcvdata_t ng_ether_rcvdata;
106 static ng_disconnect_t ng_ether_disconnect;
107 static int ng_ether_mod_event(module_t mod, int event, void *data);
109 /* Parse type for an Ethernet address */
110 static ng_parse_t ng_enaddr_parse;
111 static ng_unparse_t ng_enaddr_unparse;
112 const struct ng_parse_type ng_ether_enaddr_type = {
118 NULL, /* no such thing as a "default" EN address */
122 /* List of commands and how to convert arguments to/from ASCII */
123 static const struct ng_cmdlist ng_ether_cmdlist[] = {
126 NGM_ETHER_GET_IFNAME,
129 &ng_parse_string_type
133 NGM_ETHER_GET_IFINDEX,
140 NGM_ETHER_GET_ENADDR,
143 &ng_ether_enaddr_type
147 NGM_ETHER_SET_ENADDR,
149 &ng_ether_enaddr_type,
154 NGM_ETHER_GET_PROMISC,
161 NGM_ETHER_SET_PROMISC,
163 &ng_parse_int32_type,
168 NGM_ETHER_GET_AUTOSRC,
175 NGM_ETHER_SET_AUTOSRC,
177 &ng_parse_int32_type,
183 static struct ng_type ng_ether_typestruct = {
187 ng_ether_constructor,
198 NETGRAPH_INIT(ether, &ng_ether_typestruct);
200 /******************************************************************
201 ETHERNET FUNCTION HOOKS
202 ******************************************************************/
205 * Handle a packet that has come in on an interface. We get to
206 * look at it here before any upper layer protocols do.
208 * NOTE: this function will get called with ifp's serializer being held
211 ng_ether_input(struct ifnet *ifp, struct mbuf **mp)
213 const node_p node = IFP2NG(ifp);
214 const priv_p priv = node->private;
216 /* If "lower" hook not connected, let packet continue */
217 if (priv->lower == NULL || priv->lowerOrphan)
219 ng_ether_input2(node, mp, NULL);
223 * Handle a packet that has come in on an interface, and which
224 * does not match any of our known protocols (an ``orphan'').
226 * NOTE: this function will get called at splimp()
229 ng_ether_input_orphan(struct ifnet *ifp,
230 struct mbuf *m, const struct ether_header *eh)
232 const node_p node = IFP2NG(ifp);
233 const priv_p priv = node->private;
235 /* If "orphan" hook not connected, let packet continue */
236 if (priv->lower == NULL || !priv->lowerOrphan) {
240 ng_ether_input2(node, &m, eh);
246 * Handle a packet that has come in on an interface.
247 * The Ethernet header has already been detached from the mbuf,
248 * so we have to put it back.
250 * NOTE: this function will get called at splimp()
253 ng_ether_input2(node_p node, struct mbuf **mp, const struct ether_header *eh)
255 const priv_p priv = node->private;
259 /* Glue Ethernet header back on */
260 if (eh != NULL && (error = ng_ether_glueback_header(mp, eh)) != 0)
263 /* Send out lower/orphan hook */
264 ng_queue_data(priv->lower, *mp, meta);
269 * Handle a packet that is going out on an interface.
270 * The Ethernet header is already attached to the mbuf.
273 ng_ether_output(struct ifnet *ifp, struct mbuf **mp)
275 const node_p node = IFP2NG(ifp);
276 const priv_p priv = node->private;
280 /* If "upper" hook not connected, let packet continue */
281 if (priv->upper == NULL)
284 /* Send it out "upper" hook */
285 NG_SEND_DATA(error, priv->upper, *mp, meta);
291 * A new Ethernet interface has been attached.
292 * Create a new node for it, etc.
295 ng_ether_attach(struct ifnet *ifp)
297 char name[IFNAMSIZ + 1];
302 KASSERT(!IFP2NG(ifp), ("%s: node already exists?", __func__));
303 strlcpy(name, ifp->if_xname, sizeof(name));
304 if (ng_make_node_common(&ng_ether_typestruct, &node) != 0) {
305 log(LOG_ERR, "%s: can't %s for %s\n",
306 __func__, "create node", name);
310 /* Allocate private data */
311 MALLOC(priv, priv_p, sizeof(*priv), M_NETGRAPH, M_NOWAIT | M_ZERO);
313 log(LOG_ERR, "%s: can't %s for %s\n",
314 __func__, "allocate memory", name);
318 node->private = priv;
321 priv->autoSrcAddr = 1;
322 priv->hwassist = ifp->if_hwassist;
324 /* Try to give the node the same name as the interface */
325 if (ng_name_node(node, name) != 0) {
326 log(LOG_WARNING, "%s: can't name node %s\n",
332 * An Ethernet interface is being detached.
336 ng_ether_detach(struct ifnet *ifp)
338 const node_p node = IFP2NG(ifp);
341 if (node == NULL) /* no node (why not?), ignore */
343 ng_rmnode(node); /* break all links to other nodes */
344 node->flags |= NG_INVALID;
345 ng_unname(node); /* free name (and its reference) */
346 IFP2NG(ifp) = NULL; /* detach node from interface */
347 priv = node->private; /* free node private info */
348 bzero(priv, sizeof(*priv));
349 FREE(priv, M_NETGRAPH);
350 node->private = NULL;
351 ng_unref(node); /* free node itself */
355 * Optimization for gluing the Ethernet header back onto
356 * the front of an incoming packet.
359 ng_ether_glueback_header(struct mbuf **mp, const struct ether_header *eh)
361 struct mbuf *m = *mp;
365 * Optimize for the case where the header is already in place
366 * at the front of the mbuf. This is actually quite likely
367 * because many Ethernet drivers generate packets this way.
369 if (eh == mtod(m, struct ether_header *) - 1) {
370 m->m_len += sizeof(*eh);
371 m->m_data -= sizeof(*eh);
372 m->m_pkthdr.len += sizeof(*eh);
376 /* Prepend the header back onto the front of the mbuf */
377 M_PREPEND(m, sizeof(*eh), MB_DONTWAIT);
383 /* Copy header into front of mbuf */
384 bcopy(eh, mtod(m, void *), sizeof(*eh));
392 /******************************************************************
393 NETGRAPH NODE METHODS
394 ******************************************************************/
397 * It is not possible or allowable to create a node of this type.
398 * Nodes get created when the interface is attached (or, when
399 * this node type's KLD is loaded).
402 ng_ether_constructor(node_p *nodep)
408 * Check for attaching a new hook.
411 ng_ether_newhook(node_p node, hook_p hook, const char *name)
413 const priv_p priv = node->private;
414 u_char orphan = priv->lowerOrphan;
417 /* Divert hook is an alias for lower */
418 if (strcmp(name, NG_ETHER_HOOK_DIVERT) == 0)
419 name = NG_ETHER_HOOK_LOWER;
422 if (strcmp(name, NG_ETHER_HOOK_UPPER) == 0)
423 hookptr = &priv->upper;
424 else if (strcmp(name, NG_ETHER_HOOK_LOWER) == 0) {
425 hookptr = &priv->lower;
427 } else if (strcmp(name, NG_ETHER_HOOK_ORPHAN) == 0) {
428 hookptr = &priv->lower;
433 /* Check if already connected (shouldn't be, but doesn't hurt) */
434 if (*hookptr != NULL)
437 /* Disable hardware checksums while 'upper' hook is connected */
438 if (hookptr == &priv->upper)
439 priv->ifp->if_hwassist = 0;
443 priv->lowerOrphan = orphan;
448 * Receive an incoming control message.
451 ng_ether_rcvmsg(node_p node, struct ng_mesg *msg,
452 const char *retaddr, struct ng_mesg **rptr)
454 const priv_p priv = node->private;
455 struct ng_mesg *resp = NULL;
458 switch (msg->header.typecookie) {
459 case NGM_ETHER_COOKIE:
460 switch (msg->header.cmd) {
461 case NGM_ETHER_GET_IFNAME:
462 NG_MKRESPONSE(resp, msg, IFNAMSIZ + 1, M_NOWAIT);
467 strlcpy(resp->data, priv->ifp->if_xname, IFNAMSIZ);
469 case NGM_ETHER_GET_IFINDEX:
470 NG_MKRESPONSE(resp, msg, sizeof(u_int32_t), M_NOWAIT);
475 *((u_int32_t *)resp->data) = priv->ifp->if_index;
477 case NGM_ETHER_GET_ENADDR:
478 NG_MKRESPONSE(resp, msg, ETHER_ADDR_LEN, M_NOWAIT);
483 bcopy((IFP2AC(priv->ifp))->ac_enaddr,
484 resp->data, ETHER_ADDR_LEN);
486 case NGM_ETHER_SET_ENADDR:
488 if (msg->header.arglen != ETHER_ADDR_LEN) {
492 error = if_setlladdr(priv->ifp,
493 (u_char *)msg->data, ETHER_ADDR_LEN);
496 case NGM_ETHER_GET_PROMISC:
497 NG_MKRESPONSE(resp, msg, sizeof(u_int32_t), M_NOWAIT);
502 *((u_int32_t *)resp->data) = priv->promisc;
504 case NGM_ETHER_SET_PROMISC:
508 if (msg->header.arglen != sizeof(u_int32_t)) {
512 want = !!*((u_int32_t *)msg->data);
513 if (want ^ priv->promisc) {
514 if ((error = ifpromisc(priv->ifp, want)) != 0)
516 priv->promisc = want;
520 case NGM_ETHER_GET_AUTOSRC:
521 NG_MKRESPONSE(resp, msg, sizeof(u_int32_t), M_NOWAIT);
526 *((u_int32_t *)resp->data) = priv->autoSrcAddr;
528 case NGM_ETHER_SET_AUTOSRC:
529 if (msg->header.arglen != sizeof(u_int32_t)) {
533 priv->autoSrcAddr = !!*((u_int32_t *)msg->data);
546 else if (resp != NULL)
547 FREE(resp, M_NETGRAPH);
548 FREE(msg, M_NETGRAPH);
553 * Receive data on a hook.
556 ng_ether_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
558 const node_p node = hook->node;
559 const priv_p priv = node->private;
561 if (hook == priv->lower)
562 return ng_ether_rcv_lower(node, m, meta);
563 if (hook == priv->upper)
564 return ng_ether_rcv_upper(node, m, meta);
565 panic("%s: weird hook", __func__);
569 * Handle an mbuf received on the "lower" hook.
572 ng_ether_rcv_lower(node_p node, struct mbuf *m, meta_p meta)
574 const priv_p priv = node->private;
575 struct ifnet *const ifp = priv->ifp;
578 /* Discard meta info */
581 /* Check whether interface is ready for packets */
582 if ((ifp->if_flags & (IFF_UP|IFF_RUNNING)) != (IFF_UP|IFF_RUNNING)) {
587 /* Make sure header is fully pulled up */
588 if (m->m_pkthdr.len < sizeof(struct ether_header)) {
592 if (m->m_len < sizeof(struct ether_header)
593 && (m = m_pullup(m, sizeof(struct ether_header))) == NULL)
596 /* Drop in the MAC address if desired */
597 if (priv->autoSrcAddr) {
599 /* Make the mbuf writable if it's not already */
601 && (m = m_pullup(m, sizeof(struct ether_header))) == NULL)
604 /* Overwrite source MAC address */
605 bcopy((IFP2AC(ifp))->ac_enaddr,
606 mtod(m, struct ether_header *)->ether_shost,
610 /* Send it on its way */
611 error = ether_output_frame(ifp, m);
616 * Handle an mbuf received on the "upper" hook.
619 ng_ether_rcv_upper(node_p node, struct mbuf *m, meta_p meta)
621 const priv_p priv = node->private;
623 /* Discard meta info */
626 /* Check length and pull off header */
627 if (m->m_pkthdr.len < ETHER_HDR_LEN) {
631 if (m->m_len < ETHER_HDR_LEN &&
632 (m = m_pullup(m, ETHER_HDR_LEN)) == NULL)
635 m->m_pkthdr.rcvif = priv->ifp;
637 /* Route packet back in */
638 lwkt_serialize_enter(priv->ifp->if_serializer);
639 ether_demux(priv->ifp, m);
640 lwkt_serialize_exit(priv->ifp->if_serializer);
645 * Shutdown node. This resets the node but does not remove it.
648 ng_ether_rmnode(node_p node)
650 const priv_p priv = node->private;
653 node->flags &= ~NG_INVALID; /* bounce back to life */
654 if (priv->promisc) { /* disable promiscuous mode */
655 ifpromisc(priv->ifp, 0);
658 priv->autoSrcAddr = 1; /* reset auto-src-addr flag */
663 * Hook disconnection.
666 ng_ether_disconnect(hook_p hook)
668 const priv_p priv = hook->node->private;
670 if (hook == priv->upper) {
672 priv->ifp->if_hwassist = priv->hwassist; /* restore h/w csum */
673 } else if (hook == priv->lower) {
675 priv->lowerOrphan = 0;
677 panic("%s: weird hook", __func__);
678 if (hook->node->numhooks == 0)
679 ng_rmnode(hook->node); /* reset node */
684 ng_enaddr_parse(const struct ng_parse_type *type,
685 const char *s, int *const off, const u_char *const start,
686 u_char *const buf, int *const buflen)
692 if (*buflen < ETHER_ADDR_LEN)
694 for (i = 0; i < ETHER_ADDR_LEN; i++) {
695 val = strtoul(s + *off, &eptr, 16);
696 if (val > 0xff || eptr == s + *off)
698 buf[i] = (u_char)val;
700 if (i < ETHER_ADDR_LEN - 1) {
706 *buflen = ETHER_ADDR_LEN;
711 ng_enaddr_unparse(const struct ng_parse_type *type,
712 const u_char *data, int *off, char *cbuf, int cbuflen)
716 len = ksnprintf(cbuf, cbuflen, "%02x:%02x:%02x:%02x:%02x:%02x",
717 data[*off], data[*off + 1], data[*off + 2],
718 data[*off + 3], data[*off + 4], data[*off + 5]);
721 *off += ETHER_ADDR_LEN;
725 /******************************************************************
727 ******************************************************************/
730 * Handle loading and unloading for this node type.
733 ng_ether_mod_event(module_t mod, int event, void *data)
742 /* Register function hooks */
743 if (ng_ether_attach_p != NULL) {
747 ng_ether_attach_p = ng_ether_attach;
748 ng_ether_detach_p = ng_ether_detach;
749 ng_ether_output_p = ng_ether_output;
750 ng_ether_input_p = ng_ether_input;
751 ng_ether_input_orphan_p = ng_ether_input_orphan;
753 /* Create nodes for any already-existing Ethernet interfaces */
754 TAILQ_FOREACH(ifp, &ifnet, if_link) {
755 if (ifp->if_type == IFT_ETHER ||
756 ifp->if_type == IFT_L2VLAN)
757 ng_ether_attach(ifp);
764 * Note that the base code won't try to unload us until
765 * all nodes have been removed, and that can't happen
766 * until all Ethernet interfaces are removed. In any
767 * case, we know there are no nodes left if the action
768 * is MOD_UNLOAD, so there's no need to detach any nodes.
771 /* Unregister function hooks */
772 ng_ether_attach_p = NULL;
773 ng_ether_detach_p = NULL;
774 ng_ether_output_p = NULL;
775 ng_ether_input_p = NULL;
776 ng_ether_input_orphan_p = NULL;