7 * Copyright (c) 1996-2000 Whistle Communications, Inc.
10 * Subject to the following obligations and disclaimer of warranty, use and
11 * redistribution of this software, in source or object code forms, with or
12 * without modifications are expressly permitted by Whistle Communications;
13 * provided, however, that:
14 * 1. Any and all reproductions of the source or object code must include the
15 * copyright notice above and the following disclaimer of warranties; and
16 * 2. No rights are granted, in any manner or form, to use Whistle
17 * Communications, Inc. trademarks, including the mark "WHISTLE
18 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
19 * such appears in the above copyright notice or in the software.
21 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
22 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
23 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
24 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
26 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
27 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
28 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
29 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
30 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
31 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
32 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
33 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
34 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
36 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
39 * Authors: Archie Cobbs <archie@freebsd.org>
40 * Julian Elischer <julian@freebsd.org>
46 * ng_ether(4) netgraph node type
49 #include <sys/param.h>
50 #include <sys/systm.h>
51 #include <sys/kernel.h>
52 #include <sys/malloc.h>
54 #include <sys/errno.h>
56 #include <sys/syslog.h>
57 #include <sys/socket.h>
58 #include <sys/taskqueue.h>
61 #include <net/if_dl.h>
62 #include <net/if_types.h>
63 #include <net/if_arp.h>
64 #include <net/if_var.h>
65 #include <net/ethernet.h>
66 #include <net/if_bridgevar.h>
69 #include <netgraph/ng_message.h>
70 #include <netgraph/netgraph.h>
71 #include <netgraph/ng_parse.h>
72 #include <netgraph/ng_ether.h>
74 #define IFP2NG(ifp) (IFP2AC((ifp))->ac_netgraph)
76 /* Per-node private data */
78 struct ifnet *ifp; /* associated interface */
79 hook_p upper; /* upper hook connection */
80 hook_p lower; /* lower hook connection */
81 hook_p orphan; /* orphan hook connection */
82 u_char autoSrcAddr; /* always overwrite source address */
83 u_char promisc; /* promiscuous mode enabled */
84 u_long hwassist; /* hardware checksum capabilities */
85 u_int flags; /* flags e.g. really die */
87 typedef struct private *priv_p;
89 /* Hook pointers used by if_ethersubr.c to callback to netgraph */
90 extern void (*ng_ether_input_p)(struct ifnet *ifp, struct mbuf **mp);
91 extern void (*ng_ether_input_orphan_p)(struct ifnet *ifp, struct mbuf *m);
92 extern int (*ng_ether_output_p)(struct ifnet *ifp, struct mbuf **mp);
93 extern void (*ng_ether_attach_p)(struct ifnet *ifp);
94 extern void (*ng_ether_detach_p)(struct ifnet *ifp);
95 extern void (*ng_ether_link_state_p)(struct ifnet *ifp, int state);
97 /* Functional hooks called from if_ethersubr.c */
98 static void ng_ether_input(struct ifnet *ifp, struct mbuf **mp);
99 static void ng_ether_input_orphan(struct ifnet *ifp, struct mbuf *m);
100 static int ng_ether_output(struct ifnet *ifp, struct mbuf **mp);
101 static void ng_ether_attach(struct ifnet *ifp);
102 static void ng_ether_detach(struct ifnet *ifp);
103 static void ng_ether_link_state(struct ifnet *ifp, int state);
105 /* Other functions */
106 static int ng_ether_rcv_lower(hook_p node, item_p item);
107 static int ng_ether_rcv_upper(hook_p node, item_p item);
109 /* Netgraph node methods */
110 static ng_constructor_t ng_ether_constructor;
111 static ng_rcvmsg_t ng_ether_rcvmsg;
112 static ng_shutdown_t ng_ether_shutdown;
113 static ng_newhook_t ng_ether_newhook;
114 static ng_rcvdata_t ng_ether_rcvdata;
115 static ng_disconnect_t ng_ether_disconnect;
116 static int ng_ether_mod_event(module_t mod, int event, void *data);
118 /* List of commands and how to convert arguments to/from ASCII */
119 static const struct ng_cmdlist ng_ether_cmdlist[] = {
122 NGM_ETHER_GET_IFNAME,
125 &ng_parse_string_type
129 NGM_ETHER_GET_IFINDEX,
136 NGM_ETHER_GET_ENADDR,
139 &ng_parse_enaddr_type
143 NGM_ETHER_SET_ENADDR,
145 &ng_parse_enaddr_type,
150 NGM_ETHER_GET_PROMISC,
157 NGM_ETHER_SET_PROMISC,
159 &ng_parse_int32_type,
164 NGM_ETHER_GET_AUTOSRC,
171 NGM_ETHER_SET_AUTOSRC,
173 &ng_parse_int32_type,
180 &ng_parse_enaddr_type,
187 &ng_parse_enaddr_type,
200 static struct ng_type ng_ether_typestruct = {
201 .version = NG_ABI_VERSION,
202 .name = NG_ETHER_NODE_TYPE,
203 .mod_event = ng_ether_mod_event,
204 .constructor = ng_ether_constructor,
205 .rcvmsg = ng_ether_rcvmsg,
206 .shutdown = ng_ether_shutdown,
207 .newhook = ng_ether_newhook,
208 .rcvdata = ng_ether_rcvdata,
209 .disconnect = ng_ether_disconnect,
210 .cmdlist = ng_ether_cmdlist,
212 NETGRAPH_INIT(ether, &ng_ether_typestruct);
214 /******************************************************************
215 ETHERNET FUNCTION HOOKS
216 ******************************************************************/
219 * Handle a packet that has come in on an interface. We get to
220 * look at it here before any upper layer protocols do.
222 * NOTE: this function will get called at splimp()
225 ng_ether_input(struct ifnet *ifp, struct mbuf **mp)
227 const node_p node = IFP2NG(ifp);
228 const priv_p priv = NG_NODE_PRIVATE(node);
231 /* If "lower" hook not connected, let packet continue */
232 if (priv->lower == NULL)
234 NG_SEND_DATA_ONLY(error, priv->lower, *mp); /* sets *mp = NULL */
238 * Handle a packet that has come in on an interface, and which
239 * does not match any of our known protocols (an ``orphan'').
241 * NOTE: this function will get called at splimp()
244 ng_ether_input_orphan(struct ifnet *ifp, struct mbuf *m)
246 const node_p node = IFP2NG(ifp);
247 const priv_p priv = NG_NODE_PRIVATE(node);
250 /* If "orphan" hook not connected, discard packet */
251 if (priv->orphan == NULL) {
255 NG_SEND_DATA_ONLY(error, priv->orphan, m);
259 * Handle a packet that is going out on an interface.
260 * The Ethernet header is already attached to the mbuf.
263 ng_ether_output(struct ifnet *ifp, struct mbuf **mp)
265 const node_p node = IFP2NG(ifp);
266 const priv_p priv = NG_NODE_PRIVATE(node);
269 /* If "upper" hook not connected, let packet continue */
270 if (priv->upper == NULL)
273 /* Send it out "upper" hook */
274 NG_OUTBOUND_THREAD_REF();
275 NG_SEND_DATA_ONLY(error, priv->upper, *mp);
276 NG_OUTBOUND_THREAD_UNREF();
281 * A new Ethernet interface has been attached.
282 * Create a new node for it, etc.
285 ng_ether_attach(struct ifnet *ifp)
291 * Do not create / attach an ether node to this ifnet if
292 * a netgraph node with the same name already exists.
293 * This should prevent ether nodes to become attached to
294 * eiface nodes, which may be problematic due to naming
297 if ((node = ng_name2noderef(NULL, ifp->if_xname)) != NULL) {
303 KASSERT(!IFP2NG(ifp), ("%s: node already exists?", __func__));
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", ifp->if_xname);
310 /* Allocate private data */
311 priv = malloc(sizeof(*priv), M_NETGRAPH, M_NOWAIT | M_ZERO);
313 log(LOG_ERR, "%s: can't %s for %s\n",
314 __func__, "allocate memory", ifp->if_xname);
318 NG_NODE_SET_PRIVATE(node, priv);
321 priv->hwassist = ifp->if_hwassist;
323 /* Try to give the node the same name as the interface */
324 if (ng_name_node(node, ifp->if_xname) != 0) {
325 log(LOG_WARNING, "%s: can't name node %s\n",
326 __func__, ifp->if_xname);
331 * An Ethernet interface is being detached.
332 * REALLY Destroy its node.
335 ng_ether_detach(struct ifnet *ifp)
337 const node_p node = IFP2NG(ifp);
338 const priv_p priv = NG_NODE_PRIVATE(node);
340 taskqueue_drain(taskqueue_swi, &ifp->if_linktask);
341 NG_NODE_REALLY_DIE(node); /* Force real removal of node */
343 * We can't assume the ifnet is still around when we run shutdown
344 * So zap it now. XXX We HOPE that anything running at this time
345 * handles it (as it should in the non netgraph case).
348 priv->ifp = NULL; /* XXX race if interrupted an output packet */
349 ng_rmnode_self(node); /* remove all netgraph parts */
353 * Notify graph about link event.
354 * if_link_state_change() has already checked that the state has changed.
357 ng_ether_link_state(struct ifnet *ifp, int state)
359 const node_p node = IFP2NG(ifp);
360 const priv_p priv = NG_NODE_PRIVATE(node);
362 int cmd, dummy_error = 0;
364 if (state == LINK_STATE_UP)
365 cmd = NGM_LINK_IS_UP;
366 else if (state == LINK_STATE_DOWN)
367 cmd = NGM_LINK_IS_DOWN;
371 if (priv->lower != NULL) {
372 NG_MKMESSAGE(msg, NGM_FLOW_COOKIE, cmd, 0, M_NOWAIT);
374 NG_SEND_MSG_HOOK(dummy_error, node, msg, priv->lower, 0);
376 if (priv->orphan != NULL) {
377 NG_MKMESSAGE(msg, NGM_FLOW_COOKIE, cmd, 0, M_NOWAIT);
379 NG_SEND_MSG_HOOK(dummy_error, node, msg, priv->orphan, 0);
383 /******************************************************************
384 NETGRAPH NODE METHODS
385 ******************************************************************/
388 * It is not possible or allowable to create a node of this type.
389 * Nodes get created when the interface is attached (or, when
390 * this node type's KLD is loaded).
393 ng_ether_constructor(node_p node)
399 * Check for attaching a new hook.
402 ng_ether_newhook(node_p node, hook_p hook, const char *name)
404 const priv_p priv = NG_NODE_PRIVATE(node);
407 /* Divert hook is an alias for lower */
408 if (strcmp(name, NG_ETHER_HOOK_DIVERT) == 0)
409 name = NG_ETHER_HOOK_LOWER;
412 if (strcmp(name, NG_ETHER_HOOK_UPPER) == 0) {
413 hookptr = &priv->upper;
414 NG_HOOK_SET_RCVDATA(hook, ng_ether_rcv_upper);
415 NG_HOOK_SET_TO_INBOUND(hook);
416 } else if (strcmp(name, NG_ETHER_HOOK_LOWER) == 0) {
417 hookptr = &priv->lower;
418 NG_HOOK_SET_RCVDATA(hook, ng_ether_rcv_lower);
419 } else if (strcmp(name, NG_ETHER_HOOK_ORPHAN) == 0) {
420 hookptr = &priv->orphan;
421 NG_HOOK_SET_RCVDATA(hook, ng_ether_rcv_lower);
425 /* Check if already connected (shouldn't be, but doesn't hurt) */
426 if (*hookptr != NULL)
429 /* Disable hardware checksums while 'upper' hook is connected */
430 if (hookptr == &priv->upper)
431 priv->ifp->if_hwassist = 0;
432 NG_HOOK_HI_STACK(hook);
439 * Receive an incoming control message.
442 ng_ether_rcvmsg(node_p node, item_p item, hook_p lasthook)
444 const priv_p priv = NG_NODE_PRIVATE(node);
445 struct ng_mesg *resp = NULL;
449 NGI_GET_MSG(item, msg);
450 switch (msg->header.typecookie) {
451 case NGM_ETHER_COOKIE:
452 switch (msg->header.cmd) {
453 case NGM_ETHER_GET_IFNAME:
454 NG_MKRESPONSE(resp, msg, IFNAMSIZ, M_NOWAIT);
459 strlcpy(resp->data, priv->ifp->if_xname, IFNAMSIZ);
461 case NGM_ETHER_GET_IFINDEX:
462 NG_MKRESPONSE(resp, msg, sizeof(u_int32_t), M_NOWAIT);
467 *((u_int32_t *)resp->data) = priv->ifp->if_index;
469 case NGM_ETHER_GET_ENADDR:
470 NG_MKRESPONSE(resp, msg, ETHER_ADDR_LEN, M_NOWAIT);
475 bcopy(IF_LLADDR(priv->ifp),
476 resp->data, ETHER_ADDR_LEN);
478 case NGM_ETHER_SET_ENADDR:
480 if (msg->header.arglen != ETHER_ADDR_LEN) {
484 error = if_setlladdr(priv->ifp,
485 (u_char *)msg->data, ETHER_ADDR_LEN);
486 EVENTHANDLER_INVOKE(iflladdr_event, priv->ifp);
489 case NGM_ETHER_GET_PROMISC:
490 NG_MKRESPONSE(resp, msg, sizeof(u_int32_t), M_NOWAIT);
495 *((u_int32_t *)resp->data) = priv->promisc;
497 case NGM_ETHER_SET_PROMISC:
501 if (msg->header.arglen != sizeof(u_int32_t)) {
505 want = !!*((u_int32_t *)msg->data);
506 if (want ^ priv->promisc) {
507 if ((error = ifpromisc(priv->ifp, want)) != 0)
509 priv->promisc = want;
513 case NGM_ETHER_GET_AUTOSRC:
514 NG_MKRESPONSE(resp, msg, sizeof(u_int32_t), M_NOWAIT);
519 *((u_int32_t *)resp->data) = priv->autoSrcAddr;
521 case NGM_ETHER_SET_AUTOSRC:
522 if (msg->header.arglen != sizeof(u_int32_t)) {
526 priv->autoSrcAddr = !!*((u_int32_t *)msg->data);
528 case NGM_ETHER_ADD_MULTI:
530 struct sockaddr_dl sa_dl;
531 struct ifmultiaddr *ifma;
533 if (msg->header.arglen != ETHER_ADDR_LEN) {
537 bzero(&sa_dl, sizeof(struct sockaddr_dl));
538 sa_dl.sdl_len = sizeof(struct sockaddr_dl);
539 sa_dl.sdl_family = AF_LINK;
540 sa_dl.sdl_alen = ETHER_ADDR_LEN;
541 bcopy((void *)msg->data, LLADDR(&sa_dl),
544 * Netgraph is only permitted to join groups once
545 * via the if_addmulti() KPI, because it cannot hold
546 * struct ifmultiaddr * between calls. It may also
547 * lose a race while we check if the membership
550 if_maddr_rlock(priv->ifp);
551 ifma = if_findmulti(priv->ifp,
552 (struct sockaddr *)&sa_dl);
553 if_maddr_runlock(priv->ifp);
557 error = if_addmulti(priv->ifp,
558 (struct sockaddr *)&sa_dl, &ifma);
562 case NGM_ETHER_DEL_MULTI:
564 struct sockaddr_dl sa_dl;
566 if (msg->header.arglen != ETHER_ADDR_LEN) {
570 bzero(&sa_dl, sizeof(struct sockaddr_dl));
571 sa_dl.sdl_len = sizeof(struct sockaddr_dl);
572 sa_dl.sdl_family = AF_LINK;
573 sa_dl.sdl_alen = ETHER_ADDR_LEN;
574 bcopy((void *)msg->data, LLADDR(&sa_dl),
576 error = if_delmulti(priv->ifp,
577 (struct sockaddr *)&sa_dl);
580 case NGM_ETHER_DETACH:
581 ng_ether_detach(priv->ifp);
592 NG_RESPOND_MSG(error, node, item, resp);
598 * Receive data on a hook.
599 * Since we use per-hook recveive methods this should never be called.
602 ng_ether_rcvdata(hook_p hook, item_p item)
606 panic("%s: weird hook", __func__);
610 * Handle an mbuf received on the "lower" or "orphan" hook.
613 ng_ether_rcv_lower(hook_p hook, item_p item)
616 const node_p node = NG_HOOK_NODE(hook);
617 const priv_p priv = NG_NODE_PRIVATE(node);
618 struct ifnet *const ifp = priv->ifp;
623 /* Check whether interface is ready for packets */
625 if (!((ifp->if_flags & IFF_UP) &&
626 (ifp->if_drv_flags & IFF_DRV_RUNNING))) {
631 /* Make sure header is fully pulled up */
632 if (m->m_pkthdr.len < sizeof(struct ether_header)) {
636 if (m->m_len < sizeof(struct ether_header)
637 && (m = m_pullup(m, sizeof(struct ether_header))) == NULL)
640 /* Drop in the MAC address if desired */
641 if (priv->autoSrcAddr) {
643 /* Make the mbuf writable if it's not already */
645 && (m = m_pullup(m, sizeof(struct ether_header))) == NULL)
648 /* Overwrite source MAC address */
649 bcopy(IF_LLADDR(ifp),
650 mtod(m, struct ether_header *)->ether_shost,
654 /* Send it on its way */
655 return ether_output_frame(ifp, m);
659 * Handle an mbuf received on the "upper" hook.
662 ng_ether_rcv_upper(hook_p hook, item_p item)
665 const node_p node = NG_HOOK_NODE(hook);
666 const priv_p priv = NG_NODE_PRIVATE(node);
667 struct ifnet *ifp = priv->ifp;
672 /* Check length and pull off header */
673 if (m->m_pkthdr.len < sizeof(struct ether_header)) {
677 if (m->m_len < sizeof(struct ether_header) &&
678 (m = m_pullup(m, sizeof(struct ether_header))) == NULL)
681 m->m_pkthdr.rcvif = ifp;
683 /* Pass the packet to the bridge, it may come back to us */
684 if (ifp->if_bridge) {
685 BRIDGE_INPUT(ifp, m);
690 /* Route packet back in */
696 * Shutdown node. This resets the node but does not remove it
697 * unless the REALLY_DIE flag is set.
700 ng_ether_shutdown(node_p node)
702 const priv_p priv = NG_NODE_PRIVATE(node);
704 if (node->nd_flags & NGF_REALLY_DIE) {
706 * WE came here because the ethernet card is being unloaded,
707 * so stop being persistant.
708 * Actually undo all the things we did on creation.
709 * Assume the ifp has already been freed.
711 NG_NODE_SET_PRIVATE(node, NULL);
712 free(priv, M_NETGRAPH);
713 NG_NODE_UNREF(node); /* free node itself */
716 if (priv->promisc) { /* disable promiscuous mode */
717 (void)ifpromisc(priv->ifp, 0);
720 NG_NODE_REVIVE(node); /* Signal ng_rmnode we are persisant */
726 * Hook disconnection.
729 ng_ether_disconnect(hook_p hook)
731 const priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
733 if (hook == priv->upper) {
735 if (priv->ifp != NULL) /* restore h/w csum */
736 priv->ifp->if_hwassist = priv->hwassist;
737 } else if (hook == priv->lower)
739 else if (hook == priv->orphan)
742 panic("%s: weird hook", __func__);
743 if ((NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0)
744 && (NG_NODE_IS_VALID(NG_HOOK_NODE(hook))))
745 ng_rmnode_self(NG_HOOK_NODE(hook)); /* reset node */
749 /******************************************************************
751 ******************************************************************/
754 * Handle loading and unloading for this node type.
757 ng_ether_mod_event(module_t mod, int event, void *data)
766 /* Register function hooks */
767 if (ng_ether_attach_p != NULL) {
771 ng_ether_attach_p = ng_ether_attach;
772 ng_ether_detach_p = ng_ether_detach;
773 ng_ether_output_p = ng_ether_output;
774 ng_ether_input_p = ng_ether_input;
775 ng_ether_input_orphan_p = ng_ether_input_orphan;
776 ng_ether_link_state_p = ng_ether_link_state;
783 * Note that the base code won't try to unload us until
784 * all nodes have been removed, and that can't happen
785 * until all Ethernet interfaces are removed. In any
786 * case, we know there are no nodes left if the action
787 * is MOD_UNLOAD, so there's no need to detach any nodes.
790 /* Unregister function hooks */
791 ng_ether_attach_p = NULL;
792 ng_ether_detach_p = NULL;
793 ng_ether_output_p = NULL;
794 ng_ether_input_p = NULL;
795 ng_ether_input_orphan_p = NULL;
796 ng_ether_link_state_p = NULL;
808 vnet_ng_ether_init(const void *unused)
812 /* If module load was rejected, don't attach to vnets. */
813 if (ng_ether_attach_p != ng_ether_attach)
816 /* Create nodes for any already-existing Ethernet interfaces. */
818 TAILQ_FOREACH(ifp, &V_ifnet, if_link) {
819 if (ifp->if_type == IFT_ETHER
820 || ifp->if_type == IFT_L2VLAN)
821 ng_ether_attach(ifp);
825 VNET_SYSINIT(vnet_ng_ether_init, SI_SUB_PSEUDO, SI_ORDER_ANY,
826 vnet_ng_ether_init, NULL);