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>
55 #include <sys/syslog.h>
56 #include <sys/socket.h>
59 #include <net/if_dl.h>
60 #include <net/if_types.h>
61 #include <net/if_arp.h>
62 #include <net/if_var.h>
63 #include <net/ethernet.h>
65 #include <netgraph/ng_message.h>
66 #include <netgraph/netgraph.h>
67 #include <netgraph/ng_parse.h>
68 #include <netgraph/ng_ether.h>
70 #define IFP2NG(ifp) ((struct ng_node *)IFP2AC((ifp))->ac_netgraph)
71 #define IFP2NG_SET(ifp, val) (IFP2AC((ifp))->ac_netgraph = (val))
73 /* Per-node private data */
75 struct ifnet *ifp; /* associated interface */
76 hook_p upper; /* upper hook connection */
77 hook_p lower; /* lower hook connection */
78 hook_p orphan; /* orphan hook connection */
79 u_char autoSrcAddr; /* always overwrite source address */
80 u_char promisc; /* promiscuous mode enabled */
81 u_long hwassist; /* hardware checksum capabilities */
82 u_int flags; /* flags e.g. really die */
84 typedef struct private *priv_p;
86 /* Hook pointers used by if_ethersubr.c to callback to netgraph */
87 extern void (*ng_ether_input_p)(struct ifnet *ifp, struct mbuf **mp);
88 extern void (*ng_ether_input_orphan_p)(struct ifnet *ifp, struct mbuf *m);
89 extern int (*ng_ether_output_p)(struct ifnet *ifp, struct mbuf **mp);
90 extern void (*ng_ether_attach_p)(struct ifnet *ifp);
91 extern void (*ng_ether_detach_p)(struct ifnet *ifp);
92 extern void (*ng_ether_link_state_p)(struct ifnet *ifp, int state);
94 /* Functional hooks called from if_ethersubr.c */
95 static void ng_ether_input(struct ifnet *ifp, struct mbuf **mp);
96 static void ng_ether_input_orphan(struct ifnet *ifp, struct mbuf *m);
97 static int ng_ether_output(struct ifnet *ifp, struct mbuf **mp);
98 static void ng_ether_attach(struct ifnet *ifp);
99 static void ng_ether_detach(struct ifnet *ifp);
100 static void ng_ether_link_state(struct ifnet *ifp, int state);
102 /* Other functions */
103 static int ng_ether_rcv_lower(node_p node, struct mbuf *m);
104 static int ng_ether_rcv_upper(node_p node, struct mbuf *m);
106 /* Netgraph node methods */
107 static ng_constructor_t ng_ether_constructor;
108 static ng_rcvmsg_t ng_ether_rcvmsg;
109 static ng_shutdown_t ng_ether_shutdown;
110 static ng_newhook_t ng_ether_newhook;
111 static ng_connect_t ng_ether_connect;
112 static ng_rcvdata_t ng_ether_rcvdata;
113 static ng_disconnect_t ng_ether_disconnect;
114 static int ng_ether_mod_event(module_t mod, int event, void *data);
116 /* List of commands and how to convert arguments to/from ASCII */
117 static const struct ng_cmdlist ng_ether_cmdlist[] = {
120 NGM_ETHER_GET_IFNAME,
123 &ng_parse_string_type
127 NGM_ETHER_GET_IFINDEX,
134 NGM_ETHER_GET_ENADDR,
137 &ng_parse_enaddr_type
141 NGM_ETHER_SET_ENADDR,
143 &ng_parse_enaddr_type,
148 NGM_ETHER_GET_PROMISC,
155 NGM_ETHER_SET_PROMISC,
157 &ng_parse_int32_type,
162 NGM_ETHER_GET_AUTOSRC,
169 NGM_ETHER_SET_AUTOSRC,
171 &ng_parse_int32_type,
178 &ng_parse_enaddr_type,
185 &ng_parse_enaddr_type,
198 static struct ng_type ng_ether_typestruct = {
199 .version = NG_ABI_VERSION,
200 .name = NG_ETHER_NODE_TYPE,
201 .mod_event = ng_ether_mod_event,
202 .constructor = ng_ether_constructor,
203 .rcvmsg = ng_ether_rcvmsg,
204 .shutdown = ng_ether_shutdown,
205 .newhook = ng_ether_newhook,
206 .connect = ng_ether_connect,
207 .rcvdata = ng_ether_rcvdata,
208 .disconnect = ng_ether_disconnect,
209 .cmdlist = ng_ether_cmdlist,
211 NETGRAPH_INIT(ether, &ng_ether_typestruct);
213 /******************************************************************
214 ETHERNET FUNCTION HOOKS
215 ******************************************************************/
218 * Handle a packet that has come in on an interface. We get to
219 * look at it here before any upper layer protocols do.
221 * NOTE: this function will get called at splimp()
224 ng_ether_input(struct ifnet *ifp, struct mbuf **mp)
226 const node_p node = IFP2NG(ifp);
227 const priv_p priv = NG_NODE_PRIVATE(node);
230 /* If "lower" hook not connected, let packet continue */
231 if (priv->lower == NULL)
233 NG_SEND_DATA_ONLY(error, priv->lower, *mp); /* sets *mp = NULL */
237 * Handle a packet that has come in on an interface, and which
238 * does not match any of our known protocols (an ``orphan'').
240 * NOTE: this function will get called at splimp()
243 ng_ether_input_orphan(struct ifnet *ifp, struct mbuf *m)
245 const node_p node = IFP2NG(ifp);
246 const priv_p priv = NG_NODE_PRIVATE(node);
249 /* If "orphan" hook not connected, discard packet */
250 if (priv->orphan == NULL) {
254 NG_SEND_DATA_ONLY(error, priv->orphan, m);
258 * Handle a packet that is going out on an interface.
259 * The Ethernet header is already attached to the mbuf.
262 ng_ether_output(struct ifnet *ifp, struct mbuf **mp)
264 const node_p node = IFP2NG(ifp);
265 const priv_p priv = NG_NODE_PRIVATE(node);
268 /* If "upper" hook not connected, let packet continue */
269 if (priv->upper == NULL)
272 /* Send it out "upper" hook */
273 NG_SEND_DATA_ONLY(error, priv->upper, *mp);
278 * A new Ethernet interface has been attached.
279 * Create a new node for it, etc.
282 ng_ether_attach(struct ifnet *ifp)
288 KASSERT(!IFP2NG(ifp), ("%s: node already exists?", __func__));
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", ifp->if_xname);
295 /* Allocate private data */
296 MALLOC(priv, priv_p, sizeof(*priv), M_NETGRAPH, M_NOWAIT | M_ZERO);
298 log(LOG_ERR, "%s: can't %s for %s\n",
299 __func__, "allocate memory", ifp->if_xname);
303 NG_NODE_SET_PRIVATE(node, priv);
305 IFP2NG_SET(ifp, node);
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, ifp->if_xname) != 0) {
311 log(LOG_WARNING, "%s: can't name node %s\n",
312 __func__, ifp->if_xname);
317 * An Ethernet interface is being detached.
318 * REALLY Destroy its node.
321 ng_ether_detach(struct ifnet *ifp)
323 const node_p node = IFP2NG(ifp);
324 const priv_p priv = NG_NODE_PRIVATE(node);
326 NG_NODE_REALLY_DIE(node); /* Force real removal of node */
328 * We can't assume the ifnet is still around when we run shutdown
329 * So zap it now. XXX We HOPE that anything running at this time
330 * handles it (as it should in the non netgraph case).
332 IFP2NG_SET(ifp, NULL);
333 priv->ifp = NULL; /* XXX race if interrupted an output packet */
334 ng_rmnode_self(node); /* remove all netgraph parts */
338 * Notify graph about link event.
339 * if_link_state_change() has already checked that the state has changed.
342 ng_ether_link_state(struct ifnet *ifp, int state)
344 const node_p node = IFP2NG(ifp);
345 const priv_p priv = NG_NODE_PRIVATE(node);
347 int cmd, dummy_error = 0;
349 if (priv->lower == NULL)
352 if (state == LINK_STATE_UP)
353 cmd = NGM_LINK_IS_UP;
354 else if (state == LINK_STATE_DOWN)
355 cmd = NGM_LINK_IS_DOWN;
359 NG_MKMESSAGE(msg, NGM_FLOW_COOKIE, cmd, 0, M_NOWAIT);
361 NG_SEND_MSG_HOOK(dummy_error, node, msg, priv->lower, 0);
364 /******************************************************************
365 NETGRAPH NODE METHODS
366 ******************************************************************/
369 * It is not possible or allowable to create a node of this type.
370 * Nodes get created when the interface is attached (or, when
371 * this node type's KLD is loaded).
374 ng_ether_constructor(node_p node)
380 * Check for attaching a new hook.
383 ng_ether_newhook(node_p node, hook_p hook, const char *name)
385 const priv_p priv = NG_NODE_PRIVATE(node);
388 /* Divert hook is an alias for lower */
389 if (strcmp(name, NG_ETHER_HOOK_DIVERT) == 0)
390 name = NG_ETHER_HOOK_LOWER;
393 if (strcmp(name, NG_ETHER_HOOK_UPPER) == 0)
394 hookptr = &priv->upper;
395 else if (strcmp(name, NG_ETHER_HOOK_LOWER) == 0)
396 hookptr = &priv->lower;
397 else if (strcmp(name, NG_ETHER_HOOK_ORPHAN) == 0)
398 hookptr = &priv->orphan;
402 /* Check if already connected (shouldn't be, but doesn't hurt) */
403 if (*hookptr != NULL)
406 /* Disable hardware checksums while 'upper' hook is connected */
407 if (hookptr == &priv->upper)
408 priv->ifp->if_hwassist = 0;
416 * Hooks are attached, adjust to force queueing.
417 * We don't really care which hook it is.
418 * they should all be queuing for outgoing data.
421 ng_ether_connect(hook_p hook)
423 NG_HOOK_FORCE_QUEUE(NG_HOOK_PEER(hook));
428 * Receive an incoming control message.
431 ng_ether_rcvmsg(node_p node, item_p item, hook_p lasthook)
433 const priv_p priv = NG_NODE_PRIVATE(node);
434 struct ng_mesg *resp = NULL;
438 NGI_GET_MSG(item, msg);
439 switch (msg->header.typecookie) {
440 case NGM_ETHER_COOKIE:
441 switch (msg->header.cmd) {
442 case NGM_ETHER_GET_IFNAME:
443 NG_MKRESPONSE(resp, msg, IFNAMSIZ, M_NOWAIT);
448 strlcpy(resp->data, priv->ifp->if_xname, IFNAMSIZ);
450 case NGM_ETHER_GET_IFINDEX:
451 NG_MKRESPONSE(resp, msg, sizeof(u_int32_t), M_NOWAIT);
456 *((u_int32_t *)resp->data) = priv->ifp->if_index;
458 case NGM_ETHER_GET_ENADDR:
459 NG_MKRESPONSE(resp, msg, ETHER_ADDR_LEN, M_NOWAIT);
464 bcopy(IFP2ENADDR(priv->ifp),
465 resp->data, ETHER_ADDR_LEN);
467 case NGM_ETHER_SET_ENADDR:
469 if (msg->header.arglen != ETHER_ADDR_LEN) {
473 error = if_setlladdr(priv->ifp,
474 (u_char *)msg->data, ETHER_ADDR_LEN);
477 case NGM_ETHER_GET_PROMISC:
478 NG_MKRESPONSE(resp, msg, sizeof(u_int32_t), M_NOWAIT);
483 *((u_int32_t *)resp->data) = priv->promisc;
485 case NGM_ETHER_SET_PROMISC:
489 if (msg->header.arglen != sizeof(u_int32_t)) {
493 want = !!*((u_int32_t *)msg->data);
494 if (want ^ priv->promisc) {
495 if ((error = ifpromisc(priv->ifp, want)) != 0)
497 priv->promisc = want;
501 case NGM_ETHER_GET_AUTOSRC:
502 NG_MKRESPONSE(resp, msg, sizeof(u_int32_t), M_NOWAIT);
507 *((u_int32_t *)resp->data) = priv->autoSrcAddr;
509 case NGM_ETHER_SET_AUTOSRC:
510 if (msg->header.arglen != sizeof(u_int32_t)) {
514 priv->autoSrcAddr = !!*((u_int32_t *)msg->data);
516 case NGM_ETHER_ADD_MULTI:
518 struct sockaddr_dl sa_dl;
519 struct ifmultiaddr *ifm;
521 if (msg->header.arglen != ETHER_ADDR_LEN) {
525 bzero(&sa_dl, sizeof(struct sockaddr_dl));
526 sa_dl.sdl_len = sizeof(struct sockaddr_dl);
527 sa_dl.sdl_family = AF_LINK;
528 sa_dl.sdl_alen = ETHER_ADDR_LEN;
529 bcopy((void *)msg->data, LLADDR(&sa_dl),
531 error = if_addmulti(priv->ifp,
532 (struct sockaddr *)&sa_dl, &ifm);
535 case NGM_ETHER_DEL_MULTI:
537 struct sockaddr_dl sa_dl;
539 if (msg->header.arglen != ETHER_ADDR_LEN) {
543 bzero(&sa_dl, sizeof(struct sockaddr_dl));
544 sa_dl.sdl_len = sizeof(struct sockaddr_dl);
545 sa_dl.sdl_family = AF_LINK;
546 sa_dl.sdl_alen = ETHER_ADDR_LEN;
547 bcopy((void *)msg->data, LLADDR(&sa_dl),
549 error = if_delmulti(priv->ifp,
550 (struct sockaddr *)&sa_dl);
553 case NGM_ETHER_DETACH:
554 ng_ether_detach(priv->ifp);
565 NG_RESPOND_MSG(error, node, item, resp);
571 * Receive data on a hook.
574 ng_ether_rcvdata(hook_p hook, item_p item)
576 const node_p node = NG_HOOK_NODE(hook);
577 const priv_p priv = NG_NODE_PRIVATE(node);
583 if (hook == priv->lower || hook == priv->orphan)
584 return ng_ether_rcv_lower(node, m);
585 if (hook == priv->upper)
586 return ng_ether_rcv_upper(node, m);
587 panic("%s: weird hook", __func__);
588 #ifdef RESTARTABLE_PANICS /* so we don't get an error msg in LINT */
594 * Handle an mbuf received on the "lower" or "orphan" hook.
597 ng_ether_rcv_lower(node_p node, struct mbuf *m)
599 const priv_p priv = NG_NODE_PRIVATE(node);
600 struct ifnet *const ifp = priv->ifp;
602 /* Check whether interface is ready for packets */
603 if (!((ifp->if_flags & IFF_UP) &&
604 (ifp->if_drv_flags & IFF_DRV_RUNNING))) {
609 /* Make sure header is fully pulled up */
610 if (m->m_pkthdr.len < sizeof(struct ether_header)) {
614 if (m->m_len < sizeof(struct ether_header)
615 && (m = m_pullup(m, sizeof(struct ether_header))) == NULL)
618 /* Drop in the MAC address if desired */
619 if (priv->autoSrcAddr) {
621 /* Make the mbuf writable if it's not already */
623 && (m = m_pullup(m, sizeof(struct ether_header))) == NULL)
626 /* Overwrite source MAC address */
627 bcopy(IFP2ENADDR(ifp),
628 mtod(m, struct ether_header *)->ether_shost,
632 /* Send it on its way */
633 return ether_output_frame(ifp, m);
637 * Handle an mbuf received on the "upper" hook.
640 ng_ether_rcv_upper(node_p node, struct mbuf *m)
642 const priv_p priv = NG_NODE_PRIVATE(node);
644 m->m_pkthdr.rcvif = priv->ifp;
646 /* XXX: if_bridge hook here? */
648 /* Route packet back in */
649 ether_demux(priv->ifp, m);
654 * Shutdown node. This resets the node but does not remove it
655 * unless the REALLY_DIE flag is set.
658 ng_ether_shutdown(node_p node)
660 const priv_p priv = NG_NODE_PRIVATE(node);
662 if (node->nd_flags & NGF_REALLY_DIE) {
664 * WE came here because the ethernet card is being unloaded,
665 * so stop being persistant.
666 * Actually undo all the things we did on creation.
667 * Assume the ifp has already been freed.
669 NG_NODE_SET_PRIVATE(node, NULL);
670 FREE(priv, M_NETGRAPH);
671 NG_NODE_UNREF(node); /* free node itself */
674 if (priv->promisc) { /* disable promiscuous mode */
675 (void)ifpromisc(priv->ifp, 0);
678 priv->autoSrcAddr = 1; /* reset auto-src-addr flag */
679 NG_NODE_REVIVE(node); /* Signal ng_rmnode we are persisant */
685 * Hook disconnection.
688 ng_ether_disconnect(hook_p hook)
690 const priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
692 if (hook == priv->upper) {
694 if (priv->ifp != NULL) /* restore h/w csum */
695 priv->ifp->if_hwassist = priv->hwassist;
696 } else if (hook == priv->lower)
698 else if (hook == priv->orphan)
701 panic("%s: weird hook", __func__);
702 if ((NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0)
703 && (NG_NODE_IS_VALID(NG_HOOK_NODE(hook))))
704 ng_rmnode_self(NG_HOOK_NODE(hook)); /* reset node */
708 /******************************************************************
710 ******************************************************************/
713 * Handle loading and unloading for this node type.
716 ng_ether_mod_event(module_t mod, int event, void *data)
726 /* Register function hooks */
727 if (ng_ether_attach_p != NULL) {
731 ng_ether_attach_p = ng_ether_attach;
732 ng_ether_detach_p = ng_ether_detach;
733 ng_ether_output_p = ng_ether_output;
734 ng_ether_input_p = ng_ether_input;
735 ng_ether_input_orphan_p = ng_ether_input_orphan;
736 ng_ether_link_state_p = ng_ether_link_state;
738 /* Create nodes for any already-existing Ethernet interfaces */
740 TAILQ_FOREACH(ifp, &ifnet, if_link) {
741 if (ifp->if_type == IFT_ETHER
742 || ifp->if_type == IFT_L2VLAN)
743 ng_ether_attach(ifp);
751 * Note that the base code won't try to unload us until
752 * all nodes have been removed, and that can't happen
753 * until all Ethernet interfaces are removed. In any
754 * case, we know there are no nodes left if the action
755 * is MOD_UNLOAD, so there's no need to detach any nodes.
758 /* Unregister function hooks */
759 ng_ether_attach_p = NULL;
760 ng_ether_detach_p = NULL;
761 ng_ether_output_p = NULL;
762 ng_ether_input_p = NULL;
763 ng_ether_input_orphan_p = NULL;
764 ng_ether_link_state_p = NULL;