3 * Copyright (c) 1999-2001, Vitaly V Belekhov
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice unmodified, this list of conditions, and the following
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/errno.h>
34 #include <sys/kernel.h>
35 #include <sys/malloc.h>
37 #include <sys/errno.h>
39 #include <sys/sockio.h>
40 #include <sys/socket.h>
41 #include <sys/syslog.h>
44 #include <net/if_types.h>
45 #include <net/netisr.h>
46 #include <net/route.h>
49 #include <netgraph/ng_message.h>
50 #include <netgraph/netgraph.h>
51 #include <netgraph/ng_parse.h>
52 #include <netgraph/ng_eiface.h>
55 #include <net/ethernet.h>
56 #include <net/if_arp.h>
58 static const struct ng_cmdlist ng_eiface_cmdlist[] = {
61 NGM_EIFACE_GET_IFNAME,
70 &ng_parse_enaddr_type,
76 /* Node private data */
77 struct ng_eiface_private {
78 struct ifnet *ifp; /* per-interface network data */
79 int unit; /* Interface unit number */
80 node_p node; /* Our netgraph node */
81 hook_p ether; /* Hook for ethernet stream */
83 typedef struct ng_eiface_private *priv_p;
85 /* Interface methods */
86 static void ng_eiface_init(void *xsc);
87 static void ng_eiface_start(struct ifnet *ifp);
88 static int ng_eiface_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data);
90 static void ng_eiface_print_ioctl(struct ifnet *ifp, int cmd, caddr_t data);
93 /* Netgraph methods */
94 static int ng_eiface_mod_event(module_t, int, void *);
95 static ng_constructor_t ng_eiface_constructor;
96 static ng_rcvmsg_t ng_eiface_rcvmsg;
97 static ng_shutdown_t ng_eiface_rmnode;
98 static ng_newhook_t ng_eiface_newhook;
99 static ng_rcvdata_t ng_eiface_rcvdata;
100 static ng_disconnect_t ng_eiface_disconnect;
102 /* Node type descriptor */
103 static struct ng_type typestruct = {
104 .version = NG_ABI_VERSION,
105 .name = NG_EIFACE_NODE_TYPE,
106 .mod_event = ng_eiface_mod_event,
107 .constructor = ng_eiface_constructor,
108 .rcvmsg = ng_eiface_rcvmsg,
109 .shutdown = ng_eiface_rmnode,
110 .newhook = ng_eiface_newhook,
111 .rcvdata = ng_eiface_rcvdata,
112 .disconnect = ng_eiface_disconnect,
113 .cmdlist = ng_eiface_cmdlist
115 NETGRAPH_INIT(eiface, &typestruct);
117 static VNET_DEFINE(struct unrhdr *, ng_eiface_unit);
118 #define V_ng_eiface_unit VNET(ng_eiface_unit)
120 /************************************************************************
122 ************************************************************************/
125 * Process an ioctl for the virtual interface
128 ng_eiface_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
130 struct ifreq *const ifr = (struct ifreq *)data;
134 ng_eiface_print_ioctl(ifp, command, data);
139 /* These two are mostly handled at a higher layer */
141 error = ether_ioctl(ifp, command, data);
149 * If the interface is marked up and stopped, then start it.
150 * If it is marked down and running, then stop it.
152 if (ifp->if_flags & IFF_UP) {
153 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
154 ifp->if_drv_flags &= ~(IFF_DRV_OACTIVE);
155 ifp->if_drv_flags |= IFF_DRV_RUNNING;
158 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
159 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING |
164 /* Set the interface MTU */
166 if (ifr->ifr_mtu > NG_EIFACE_MTU_MAX ||
167 ifr->ifr_mtu < NG_EIFACE_MTU_MIN)
170 ifp->if_mtu = ifr->ifr_mtu;
173 /* Stuff that's not supported */
191 ng_eiface_init(void *xsc)
194 struct ifnet *ifp = sc->ifp;
199 ifp->if_drv_flags |= IFF_DRV_RUNNING;
200 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
206 * We simply relay the packet to the "ether" hook, if it is connected.
207 * We have been through the netgraph locking and are guaranteed to
208 * be the only code running in this node at this time.
211 ng_eiface_start2(node_p node, hook_p hook, void *arg1, int arg2)
213 struct ifnet *ifp = arg1;
214 const priv_p priv = (priv_p)ifp->if_softc;
218 /* Check interface flags */
220 if (!((ifp->if_flags & IFF_UP) &&
221 (ifp->if_drv_flags & IFF_DRV_RUNNING)))
226 * Grab a packet to transmit.
228 IF_DEQUEUE(&ifp->if_snd, m);
230 /* If there's nothing to send, break. */
235 * Berkeley packet filter.
236 * Pass packet to bpf if there is a listener.
237 * XXX is this safe? locking?
241 if (ifp->if_flags & IFF_MONITOR) {
248 * Send packet; if hook is not connected, mbuf will get
251 NG_OUTBOUND_THREAD_REF();
252 NG_SEND_DATA_ONLY(error, priv->ether, m);
253 NG_OUTBOUND_THREAD_UNREF();
262 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
268 * This routine is called to deliver a packet out the interface.
269 * We simply queue the netgraph version to be called when netgraph locking
270 * allows it to happen.
271 * Until we know what the rest of the networking code is doing for
272 * locking, we don't know how we will interact with it.
273 * Take comfort from the fact that the ifnet struct is part of our
274 * private info and can't go away while we are queued.
275 * [Though we don't know it is still there now....]
276 * it is possible we don't gain anything from this because
277 * we would like to get the mbuf and queue it as data
278 * somehow, but we can't and if we did would we solve anything?
281 ng_eiface_start(struct ifnet *ifp)
284 const priv_p priv = (priv_p)ifp->if_softc;
286 /* Don't do anything if output is active */
287 if (ifp->if_drv_flags & IFF_DRV_OACTIVE)
290 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
292 if (ng_send_fn(priv->node, NULL, &ng_eiface_start2, ifp, 0) != 0)
293 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
298 * Display an ioctl to the virtual interface
302 ng_eiface_print_ioctl(struct ifnet *ifp, int command, caddr_t data)
306 switch (command & IOC_DIRMASK) {
322 log(LOG_DEBUG, "%s: %s('%c', %d, char[%d])\n",
327 IOCPARM_LEN(command));
331 /************************************************************************
333 ************************************************************************/
336 * Constructor for a node
339 ng_eiface_constructor(node_p node)
343 u_char eaddr[6] = {0,0,0,0,0,0};
345 /* Allocate node and interface private structures */
346 priv = malloc(sizeof(*priv), M_NETGRAPH, M_NOWAIT | M_ZERO);
350 ifp = priv->ifp = if_alloc(IFT_ETHER);
352 free(priv, M_NETGRAPH);
356 /* Link them together */
357 ifp->if_softc = priv;
359 /* Get an interface unit number */
360 priv->unit = alloc_unr(V_ng_eiface_unit);
362 /* Link together node and private info */
363 NG_NODE_SET_PRIVATE(node, priv);
366 /* Initialize interface structure */
367 if_initname(ifp, NG_EIFACE_EIFACE_NAME, priv->unit);
368 ifp->if_init = ng_eiface_init;
369 ifp->if_output = ether_output;
370 ifp->if_start = ng_eiface_start;
371 ifp->if_ioctl = ng_eiface_ioctl;
372 ifp->if_watchdog = NULL;
373 ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
374 ifp->if_flags = (IFF_SIMPLEX | IFF_BROADCAST | IFF_MULTICAST);
376 /* Give this node the same name as the interface (if possible) */
377 if (ng_name_node(node, ifp->if_xname) != 0)
378 log(LOG_WARNING, "%s: can't acquire netgraph name\n",
381 /* Attach the interface */
382 ether_ifattach(ifp, eaddr);
389 * Give our ok for a hook to be added
392 ng_eiface_newhook(node_p node, hook_p hook, const char *name)
394 priv_p priv = NG_NODE_PRIVATE(node);
395 struct ifnet *ifp = priv->ifp;
397 if (strcmp(name, NG_EIFACE_HOOK_ETHER))
398 return (EPFNOSUPPORT);
399 if (priv->ether != NULL)
402 NG_HOOK_SET_PRIVATE(hook, &priv->ether);
403 NG_HOOK_SET_TO_INBOUND(hook);
405 if_link_state_change(ifp, LINK_STATE_UP);
411 * Receive a control message
414 ng_eiface_rcvmsg(node_p node, item_p item, hook_p lasthook)
416 const priv_p priv = NG_NODE_PRIVATE(node);
417 struct ifnet *const ifp = priv->ifp;
418 struct ng_mesg *resp = NULL;
422 NGI_GET_MSG(item, msg);
423 switch (msg->header.typecookie) {
424 case NGM_EIFACE_COOKIE:
425 switch (msg->header.cmd) {
429 if (msg->header.arglen != ETHER_ADDR_LEN) {
433 error = if_setlladdr(priv->ifp,
434 (u_char *)msg->data, ETHER_ADDR_LEN);
435 EVENTHANDLER_INVOKE(iflladdr_event, priv->ifp);
439 case NGM_EIFACE_GET_IFNAME:
440 NG_MKRESPONSE(resp, msg, IFNAMSIZ, M_NOWAIT);
445 strlcpy(resp->data, ifp->if_xname, IFNAMSIZ);
448 case NGM_EIFACE_GET_IFADDRS:
454 /* Determine size of response and allocate it */
457 TAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link)
458 buflen += SA_SIZE(ifa->ifa_addr);
459 NG_MKRESPONSE(resp, msg, buflen, M_NOWAIT);
461 if_addr_runlock(ifp);
468 TAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) {
469 const int len = SA_SIZE(ifa->ifa_addr);
472 log(LOG_ERR, "%s: len changed?\n",
476 bcopy(ifa->ifa_addr, ptr, len);
480 if_addr_runlock(ifp);
487 } /* end of inner switch() */
489 case NGM_FLOW_COOKIE:
490 switch (msg->header.cmd) {
492 if_link_state_change(ifp, LINK_STATE_UP);
494 case NGM_LINK_IS_DOWN:
495 if_link_state_change(ifp, LINK_STATE_DOWN);
505 NG_RESPOND_MSG(error, node, item, resp);
511 * Receive data from a hook. Pass the packet to the ether_input routine.
514 ng_eiface_rcvdata(hook_p hook, item_p item)
516 const priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
517 struct ifnet *const ifp = priv->ifp;
523 if (!((ifp->if_flags & IFF_UP) &&
524 (ifp->if_drv_flags & IFF_DRV_RUNNING))) {
529 if (m->m_len < ETHER_HDR_LEN) {
530 m = m_pullup(m, ETHER_HDR_LEN);
535 /* Note receiving interface */
536 m->m_pkthdr.rcvif = ifp;
538 /* Update interface stats */
541 (*ifp->if_input)(ifp, m);
548 * Shutdown processing.
551 ng_eiface_rmnode(node_p node)
553 const priv_p priv = NG_NODE_PRIVATE(node);
554 struct ifnet *const ifp = priv->ifp;
557 * the ifnet may be in a different vnet than the netgraph node,
558 * hence we have to change the current vnet context here.
560 CURVNET_SET_QUIET(ifp->if_vnet);
564 free_unr(V_ng_eiface_unit, priv->unit);
565 free(priv, M_NETGRAPH);
566 NG_NODE_SET_PRIVATE(node, NULL);
575 ng_eiface_disconnect(hook_p hook)
577 const priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
584 * Handle loading and unloading for this node type.
587 ng_eiface_mod_event(module_t mod, int event, void *data)
603 vnet_ng_eiface_init(const void *unused)
606 V_ng_eiface_unit = new_unrhdr(0, 0xffff, NULL);
608 VNET_SYSINIT(vnet_ng_eiface_init, SI_SUB_PSEUDO, SI_ORDER_ANY,
609 vnet_ng_eiface_init, NULL);
612 vnet_ng_eiface_uninit(const void *unused)
615 delete_unrhdr(V_ng_eiface_unit);
617 VNET_SYSUNINIT(vnet_ng_eiface_uninit, SI_SUB_PSEUDO, SI_ORDER_ANY,
618 vnet_ng_eiface_uninit, NULL);