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 $
44 * ng_ether(4) netgraph node type
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/kernel.h>
50 #include <sys/malloc.h>
52 #include <sys/errno.h>
53 #include <sys/syslog.h>
54 #include <sys/socket.h>
55 #include <sys/thread2.h>
58 #include <net/if_types.h>
59 #include <net/if_arp.h>
60 #include <net/if_var.h>
61 #include <net/ethernet.h>
63 #include <netgraph/ng_message.h>
64 #include <netgraph/netgraph.h>
65 #include <netgraph/ng_parse.h>
68 #define IFP2AC(IFP) ((struct arpcom *)IFP)
69 #define IFP2NG(ifp) (IFP2AC((ifp))->ac_netgraph)
71 /* Per-node private data */
73 struct ifnet *ifp; /* associated interface */
74 hook_p upper; /* upper hook connection */
75 hook_p lower; /* lower OR orphan hook connection */
76 u_char lowerOrphan; /* whether lower is lower or orphan */
77 u_char autoSrcAddr; /* always overwrite source address */
78 u_char promisc; /* promiscuous mode enabled */
79 u_long hwassist; /* hardware checksum capabilities */
81 typedef struct private *priv_p;
83 /* Functional hooks called from if_ethersubr.c */
84 static void ng_ether_input(struct ifnet *ifp, struct mbuf **mp);
85 static void ng_ether_input_orphan(struct ifnet *ifp, struct mbuf *m);
86 static int ng_ether_output(struct ifnet *ifp, struct mbuf **mp);
87 static void ng_ether_attach(struct ifnet *ifp);
88 static void ng_ether_detach(struct ifnet *ifp);
91 static void ng_ether_input2(node_p node, struct mbuf **mp);
92 static int ng_ether_rcv_lower(node_p node, struct mbuf *m, meta_p meta);
93 static int ng_ether_rcv_upper(node_p node, struct mbuf *m, meta_p meta);
95 /* Netgraph node methods */
96 static ng_constructor_t ng_ether_constructor;
97 static ng_rcvmsg_t ng_ether_rcvmsg;
98 static ng_shutdown_t ng_ether_rmnode;
99 static ng_newhook_t ng_ether_newhook;
100 static ng_rcvdata_t ng_ether_rcvdata;
101 static ng_disconnect_t ng_ether_disconnect;
102 static int ng_ether_mod_event(module_t mod, int event, void *data);
104 /* Parse type for an Ethernet address */
105 static ng_parse_t ng_enaddr_parse;
106 static ng_unparse_t ng_enaddr_unparse;
107 const struct ng_parse_type ng_ether_enaddr_type = {
113 NULL, /* no such thing as a "default" EN address */
117 /* List of commands and how to convert arguments to/from ASCII */
118 static const struct ng_cmdlist ng_ether_cmdlist[] = {
121 NGM_ETHER_GET_IFNAME,
124 &ng_parse_string_type
128 NGM_ETHER_GET_IFINDEX,
135 NGM_ETHER_GET_ENADDR,
138 &ng_ether_enaddr_type
142 NGM_ETHER_SET_ENADDR,
144 &ng_ether_enaddr_type,
149 NGM_ETHER_GET_PROMISC,
156 NGM_ETHER_SET_PROMISC,
158 &ng_parse_int32_type,
163 NGM_ETHER_GET_AUTOSRC,
170 NGM_ETHER_SET_AUTOSRC,
172 &ng_parse_int32_type,
178 static struct ng_type ng_ether_typestruct = {
182 ng_ether_constructor,
193 NETGRAPH_INIT(ether, &ng_ether_typestruct);
195 /******************************************************************
196 ETHERNET FUNCTION HOOKS
197 ******************************************************************/
200 * Handle a packet that has come in on an interface. We get to
201 * look at it here before any upper layer protocols do.
204 ng_ether_input(struct ifnet *ifp, struct mbuf **mp)
206 const node_p node = IFP2NG(ifp);
207 const priv_p priv = node->private;
209 /* If "lower" hook not connected, let packet continue */
210 if (priv->lower == NULL || priv->lowerOrphan)
212 ng_ether_input2(node, mp);
216 * Handle a packet that has come in on an interface, and which
217 * does not match any of our known protocols (an ``orphan'').
220 ng_ether_input_orphan(struct ifnet *ifp, struct mbuf *m)
222 const node_p node = IFP2NG(ifp);
223 const priv_p priv = node->private;
225 /* If "orphan" hook not connected, let packet continue */
226 if (priv->lower == NULL || !priv->lowerOrphan) {
230 ng_ether_input2(node, &m);
236 * Handle a packet that has come in on an interface.
237 * The Ethernet header has already been detached from the mbuf,
238 * so we have to put it back.
240 * NOTE: this function will get called at splimp()
243 ng_ether_input2(node_p node, struct mbuf **mp)
245 const priv_p priv = node->private;
248 /* Send out lower/orphan hook */
249 ng_queue_data(priv->lower, *mp, meta);
254 * Handle a packet that is going out on an interface.
255 * The Ethernet header is already attached to the mbuf.
258 ng_ether_output(struct ifnet *ifp, struct mbuf **mp)
260 const node_p node = IFP2NG(ifp);
261 const priv_p priv = node->private;
265 /* If "upper" hook not connected, let packet continue */
266 if (priv->upper == NULL)
269 /* Send it out "upper" hook */
270 NG_SEND_DATA(error, priv->upper, *mp, meta);
276 * A new Ethernet interface has been attached.
277 * Create a new node for it, etc.
280 ng_ether_attach(struct ifnet *ifp)
282 char name[IFNAMSIZ + 1];
287 KASSERT(!IFP2NG(ifp), ("%s: node already exists?", __func__));
288 strlcpy(name, ifp->if_xname, sizeof(name));
289 if (ng_make_node_common(&ng_ether_typestruct, &node) != 0) {
290 log(LOG_ERR, "%s: can't %s for %s\n",
291 __func__, "create node", name);
295 /* Allocate private data */
296 priv = kmalloc(sizeof(*priv), M_NETGRAPH, M_NOWAIT | M_ZERO);
298 log(LOG_ERR, "%s: can't %s for %s\n",
299 __func__, "allocate memory", name);
303 node->private = priv;
306 priv->autoSrcAddr = 1;
307 priv->hwassist = ifp->if_hwassist;
309 /* Try to give the node the same name as the interface */
310 if (ng_name_node(node, name) != 0) {
311 log(LOG_WARNING, "%s: can't name node %s\n",
317 * An Ethernet interface is being detached.
321 ng_ether_detach(struct ifnet *ifp)
323 const node_p node = IFP2NG(ifp);
326 if (node == NULL) /* no node (why not?), ignore */
328 ng_rmnode(node); /* break all links to other nodes */
329 node->flags |= NG_INVALID;
330 ng_unname(node); /* free name (and its reference) */
331 IFP2NG(ifp) = NULL; /* detach node from interface */
332 priv = node->private; /* free node private info */
333 bzero(priv, sizeof(*priv));
334 kfree(priv, M_NETGRAPH);
335 node->private = NULL;
336 ng_unref(node); /* free node itself */
339 /******************************************************************
340 NETGRAPH NODE METHODS
341 ******************************************************************/
344 * It is not possible or allowable to create a node of this type.
345 * Nodes get created when the interface is attached (or, when
346 * this node type's KLD is loaded).
349 ng_ether_constructor(node_p *nodep)
355 * Check for attaching a new hook.
358 ng_ether_newhook(node_p node, hook_p hook, const char *name)
360 const priv_p priv = node->private;
361 u_char orphan = priv->lowerOrphan;
364 /* Divert hook is an alias for lower */
365 if (strcmp(name, NG_ETHER_HOOK_DIVERT) == 0)
366 name = NG_ETHER_HOOK_LOWER;
369 if (strcmp(name, NG_ETHER_HOOK_UPPER) == 0)
370 hookptr = &priv->upper;
371 else if (strcmp(name, NG_ETHER_HOOK_LOWER) == 0) {
372 hookptr = &priv->lower;
374 } else if (strcmp(name, NG_ETHER_HOOK_ORPHAN) == 0) {
375 hookptr = &priv->lower;
380 /* Check if already connected (shouldn't be, but doesn't hurt) */
381 if (*hookptr != NULL)
384 /* Disable hardware checksums while 'upper' hook is connected */
385 if (hookptr == &priv->upper)
386 priv->ifp->if_hwassist = 0;
390 priv->lowerOrphan = orphan;
395 * Receive an incoming control message.
398 ng_ether_rcvmsg(node_p node, struct ng_mesg *msg,
399 const char *retaddr, struct ng_mesg **rptr)
401 const priv_p priv = node->private;
402 struct ng_mesg *resp = NULL;
405 switch (msg->header.typecookie) {
406 case NGM_ETHER_COOKIE:
407 switch (msg->header.cmd) {
408 case NGM_ETHER_GET_IFNAME:
409 NG_MKRESPONSE(resp, msg, IFNAMSIZ + 1, M_NOWAIT);
414 strlcpy(resp->data, priv->ifp->if_xname, IFNAMSIZ);
416 case NGM_ETHER_GET_IFINDEX:
417 NG_MKRESPONSE(resp, msg, sizeof(u_int32_t), M_NOWAIT);
422 *((u_int32_t *)resp->data) = priv->ifp->if_index;
424 case NGM_ETHER_GET_ENADDR:
425 NG_MKRESPONSE(resp, msg, ETHER_ADDR_LEN, M_NOWAIT);
430 bcopy((IFP2AC(priv->ifp))->ac_enaddr,
431 resp->data, ETHER_ADDR_LEN);
433 case NGM_ETHER_SET_ENADDR:
435 if (msg->header.arglen != ETHER_ADDR_LEN) {
439 error = if_setlladdr(priv->ifp,
440 (u_char *)msg->data, ETHER_ADDR_LEN);
443 case NGM_ETHER_GET_PROMISC:
444 NG_MKRESPONSE(resp, msg, sizeof(u_int32_t), M_NOWAIT);
449 *((u_int32_t *)resp->data) = priv->promisc;
451 case NGM_ETHER_SET_PROMISC:
455 if (msg->header.arglen != sizeof(u_int32_t)) {
459 want = !!*((u_int32_t *)msg->data);
460 if (want ^ priv->promisc) {
461 if ((error = ifpromisc(priv->ifp, want)) != 0)
463 priv->promisc = want;
467 case NGM_ETHER_GET_AUTOSRC:
468 NG_MKRESPONSE(resp, msg, sizeof(u_int32_t), M_NOWAIT);
473 *((u_int32_t *)resp->data) = priv->autoSrcAddr;
475 case NGM_ETHER_SET_AUTOSRC:
476 if (msg->header.arglen != sizeof(u_int32_t)) {
480 priv->autoSrcAddr = !!*((u_int32_t *)msg->data);
493 else if (resp != NULL)
494 kfree(resp, M_NETGRAPH);
495 kfree(msg, M_NETGRAPH);
500 * Receive data on a hook.
503 ng_ether_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
505 const node_p node = hook->node;
506 const priv_p priv = node->private;
508 if (hook == priv->lower)
509 return ng_ether_rcv_lower(node, m, meta);
510 if (hook == priv->upper)
511 return ng_ether_rcv_upper(node, m, meta);
512 panic("%s: weird hook", __func__);
516 * Handle an mbuf received on the "lower" hook.
519 ng_ether_rcv_lower(node_p node, struct mbuf *m, meta_p meta)
521 const priv_p priv = node->private;
522 struct ifnet *const ifp = priv->ifp;
525 /* Discard meta info */
528 /* Check whether interface is ready for packets */
529 if ((ifp->if_flags & (IFF_UP|IFF_RUNNING)) != (IFF_UP|IFF_RUNNING)) {
534 /* Make sure header is fully pulled up */
535 if (m->m_pkthdr.len < sizeof(struct ether_header)) {
539 if (m->m_len < sizeof(struct ether_header)
540 && (m = m_pullup(m, sizeof(struct ether_header))) == NULL)
543 /* Drop in the MAC address if desired */
544 if (priv->autoSrcAddr) {
546 /* Make the mbuf writable if it's not already */
548 && (m = m_pullup(m, sizeof(struct ether_header))) == NULL)
551 /* Overwrite source MAC address */
552 bcopy((IFP2AC(ifp))->ac_enaddr,
553 mtod(m, struct ether_header *)->ether_shost,
557 /* Send it on its way */
558 error = ether_output_frame(ifp, m);
563 * Handle an mbuf received on the "upper" hook.
566 ng_ether_rcv_upper(node_p node, struct mbuf *m, meta_p meta)
568 const priv_p priv = node->private;
570 /* Discard meta info */
573 /* Check length and pull off header */
574 if (m->m_pkthdr.len < ETHER_HDR_LEN) {
578 if (m->m_len < ETHER_HDR_LEN &&
579 (m = m_pullup(m, ETHER_HDR_LEN)) == NULL)
582 m->m_pkthdr.rcvif = priv->ifp;
584 /* Route packet back in */
590 * Shutdown node. This resets the node but does not remove it.
593 ng_ether_rmnode(node_p node)
595 const priv_p priv = node->private;
598 node->flags &= ~NG_INVALID; /* bounce back to life */
599 if (priv->promisc) { /* disable promiscuous mode */
600 ifpromisc(priv->ifp, 0);
603 priv->autoSrcAddr = 1; /* reset auto-src-addr flag */
608 * Hook disconnection.
611 ng_ether_disconnect(hook_p hook)
613 const priv_p priv = hook->node->private;
615 if (hook == priv->upper) {
617 priv->ifp->if_hwassist = priv->hwassist; /* restore h/w csum */
618 } else if (hook == priv->lower) {
620 priv->lowerOrphan = 0;
622 panic("%s: weird hook", __func__);
623 if (hook->node->numhooks == 0)
624 ng_rmnode(hook->node); /* reset node */
629 ng_enaddr_parse(const struct ng_parse_type *type,
630 const char *s, int *const off, const u_char *const start,
631 u_char *const buf, int *const buflen)
637 if (*buflen < ETHER_ADDR_LEN)
639 for (i = 0; i < ETHER_ADDR_LEN; i++) {
640 val = strtoul(s + *off, &eptr, 16);
641 if (val > 0xff || eptr == s + *off)
643 buf[i] = (u_char)val;
645 if (i < ETHER_ADDR_LEN - 1) {
651 *buflen = ETHER_ADDR_LEN;
656 ng_enaddr_unparse(const struct ng_parse_type *type,
657 const u_char *data, int *off, char *cbuf, int cbuflen)
661 len = ksnprintf(cbuf, cbuflen, "%02x:%02x:%02x:%02x:%02x:%02x",
662 data[*off], data[*off + 1], data[*off + 2],
663 data[*off + 3], data[*off + 4], data[*off + 5]);
666 *off += ETHER_ADDR_LEN;
670 /******************************************************************
672 ******************************************************************/
675 * Handle loading and unloading for this node type.
678 ng_ether_mod_event(module_t mod, int event, void *data)
687 /* Register function hooks */
688 if (ng_ether_attach_p != NULL) {
692 ng_ether_attach_p = ng_ether_attach;
693 ng_ether_detach_p = ng_ether_detach;
694 ng_ether_output_p = ng_ether_output;
695 ng_ether_input_p = ng_ether_input;
696 ng_ether_input_orphan_p = ng_ether_input_orphan;
698 /* Create nodes for any already-existing Ethernet interfaces */
699 TAILQ_FOREACH(ifp, &ifnet, if_link) {
700 if (ifp->if_type == IFT_ETHER ||
701 ifp->if_type == IFT_L2VLAN)
702 ng_ether_attach(ifp);
709 * Note that the base code won't try to unload us until
710 * all nodes have been removed, and that can't happen
711 * until all Ethernet interfaces are removed. In any
712 * case, we know there are no nodes left if the action
713 * is MOD_UNLOAD, so there's no need to detach any nodes.
716 /* Unregister function hooks */
717 ng_ether_attach_p = NULL;
718 ng_ether_detach_p = NULL;
719 ng_ether_output_p = NULL;
720 ng_ether_input_p = NULL;
721 ng_ether_input_orphan_p = NULL;