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
28 * $FreeBSD: src/sys/netgraph/ng_eiface.c,v 1.39 2007/07/26 10:54:33 glebius Exp $
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/sockio.h>
38 #include <sys/socket.h>
39 #include <sys/syslog.h>
42 #include <net/if_types.h>
43 #include <net/ifq_var.h>
44 #include <net/netisr.h>
45 #include <net/route.h>
47 #include <netgraph7/netgraph.h>
48 #include <netgraph7/ng_message.h>
49 #include <netgraph7/ng_parse.h>
50 #include "ng_eiface.h"
53 #include <net/ethernet.h>
54 #include <net/if_arp.h>
56 static const struct ng_cmdlist ng_eiface_cmdlist[] = {
59 NGM_EIFACE_GET_IFNAME,
68 &ng_parse_enaddr_type,
74 /* Node private data */
75 struct ng_eiface_private {
76 struct ifnet *ifp; /* per-interface network data */
77 int unit; /* Interface unit number */
78 node_p node; /* Our netgraph node */
79 hook_p ether; /* Hook for ethernet stream */
81 typedef struct ng_eiface_private *priv_p;
83 /* Interface methods */
84 static void ng_eiface_init(void *xsc);
85 static void ng_eiface_start(struct ifnet *ifp, struct ifaltq_subque *);
86 static int ng_eiface_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data,
89 static void ng_eiface_print_ioctl(struct ifnet *ifp, int cmd, caddr_t data);
92 /* Netgraph methods */
93 static int ng_eiface_mod_event(module_t, int, void *);
94 static ng_constructor_t ng_eiface_constructor;
95 static ng_rcvmsg_t ng_eiface_rcvmsg;
96 static ng_shutdown_t ng_eiface_rmnode;
97 static ng_newhook_t ng_eiface_newhook;
98 static ng_rcvdata_t ng_eiface_rcvdata;
99 static ng_disconnect_t ng_eiface_disconnect;
101 /* Node type descriptor */
102 static struct ng_type typestruct = {
103 .version = NG_ABI_VERSION,
104 .name = NG_EIFACE_NODE_TYPE,
105 .mod_event = ng_eiface_mod_event,
106 .constructor = ng_eiface_constructor,
107 .rcvmsg = ng_eiface_rcvmsg,
108 .shutdown = ng_eiface_rmnode,
109 .newhook = ng_eiface_newhook,
110 .rcvdata = ng_eiface_rcvdata,
111 .disconnect = ng_eiface_disconnect,
112 .cmdlist = ng_eiface_cmdlist
114 NETGRAPH_INIT(eiface, &typestruct);
116 static int ng_eiface_next_unit;
118 /************************************************************************
120 ************************************************************************/
123 * Process an ioctl for the virtual interface
126 ng_eiface_ioctl(struct ifnet *ifp, u_long command, caddr_t data, struct ucred *cr)
128 struct ifreq *const ifr = (struct ifreq *)data;
132 ng_eiface_print_ioctl(ifp, command, data);
137 /* These two are mostly handled at a higher layer */
139 error = ether_ioctl(ifp, command, data);
147 * If the interface is marked up and stopped, then start it.
148 * If it is marked down and running, then stop it.
150 if (ifp->if_flags & IFF_UP) {
151 if (!(ifp->if_flags & IFF_RUNNING)) {
152 ifq_clr_oactive(&ifp->if_snd);
153 ifp->if_flags |= IFF_RUNNING;
156 if (ifp->if_flags & IFF_RUNNING)
157 ifq_clr_oactive(&ifp->if_snd);
158 ifp->if_flags &= ~(IFF_RUNNING);
162 /* Set the interface MTU */
164 if (ifr->ifr_mtu > NG_EIFACE_MTU_MAX ||
165 ifr->ifr_mtu < NG_EIFACE_MTU_MIN)
168 ifp->if_mtu = ifr->ifr_mtu;
171 /* Stuff that's not supported */
189 ng_eiface_init(void *xsc)
192 struct ifnet *ifp = sc->ifp;
196 ifp->if_flags |= IFF_RUNNING;
197 ifq_clr_oactive(&ifp->if_snd);
204 * We simply relay the packet to the "ether" hook, if it is connected.
205 * We have been through the netgraph locking and are guaranteed to
206 * be the only code running in this node at this time.
209 ng_eiface_start2(node_p node, hook_p hook, void *arg1, int arg2)
211 struct ifnet *ifp = arg1;
212 const priv_p priv = (priv_p)ifp->if_softc;
216 /* Check interface flags */
218 if (!((ifp->if_flags & IFF_UP) &&
219 (ifp->if_flags & IFF_RUNNING)))
224 * Grab a packet to transmit.
226 m = ifq_dequeue(&ifp->if_snd);
228 /* If there's nothing to send, break. */
233 * Berkeley packet filter.
234 * Pass packet to bpf if there is a listener.
235 * XXX is this safe? locking?
239 if (ifp->if_flags & IFF_MONITOR) {
246 * Send packet; if hook is not connected, mbuf will get
249 NG_SEND_DATA_ONLY(error, priv->ether, m);
258 ifq_clr_oactive(&ifp->if_snd);
264 * This routine is called to deliver a packet out the interface.
265 * We simply queue the netgraph version to be called when netgraph locking
266 * allows it to happen.
267 * Until we know what the rest of the networking code is doing for
268 * locking, we don't know how we will interact with it.
269 * Take comfort from the fact that the ifnet struct is part of our
270 * private info and can't go away while we are queued.
271 * [Though we don't know it is still there now....]
272 * it is possible we don't gain anything from this because
273 * we would like to get the mbuf and queue it as data
274 * somehow, but we can't and if we did would we solve anything?
277 ng_eiface_start(struct ifnet *ifp, struct ifaltq_subque *ifsq __unused)
280 const priv_p priv = (priv_p)ifp->if_softc;
282 /* Don't do anything if output is active */
283 if (ifq_is_oactive(&ifp->if_snd))
286 ifq_set_oactive(&ifp->if_snd);
288 if (ng_send_fn(priv->node, NULL, &ng_eiface_start2, ifp, 0) != 0)
289 ifq_clr_oactive(&ifp->if_snd);
294 * Display an ioctl to the virtual interface
298 ng_eiface_print_ioctl(struct ifnet *ifp, int command, caddr_t data)
302 switch (command & IOC_DIRMASK) {
318 log(LOG_DEBUG, "%s: %s('%c', %d, char[%d])\n",
323 IOCPARM_LEN(command));
327 /************************************************************************
329 ************************************************************************/
332 * Constructor for a node
335 ng_eiface_constructor(node_p node)
339 u_char eaddr[6] = {0,0,0,0,0,0};
341 /* Allocate node and interface private structures */
342 priv = kmalloc(sizeof(*priv), M_NETGRAPH,
343 M_WAITOK | M_NULLOK | M_ZERO);
347 ifp = priv->ifp = if_alloc(IFT_ETHER);
349 kfree(priv, M_NETGRAPH);
353 /* Link them together */
354 ifp->if_softc = priv;
356 /* Get an interface unit number */
357 priv->unit = ng_eiface_next_unit++;
359 /* Link together node and private info */
360 NG_NODE_SET_PRIVATE(node, priv);
363 /* Initialize interface structure */
364 if_initname(ifp, NG_EIFACE_EIFACE_NAME, priv->unit);
365 ifp->if_init = ng_eiface_init;
367 ifp->if_output = ether_output;
369 ifp->if_start = ng_eiface_start;
370 ifp->if_ioctl = ng_eiface_ioctl;
371 ifp->if_watchdog = NULL;
372 ifq_set_maxlen(&ifp->if_snd, IFQ_MAXLEN);
373 ifp->if_flags = (IFF_SIMPLEX | IFF_BROADCAST | IFF_MULTICAST);
376 /* Give this node name */
377 bzero(ifname, sizeof(ifname));
378 ksprintf(ifname, "if%s", ifp->if_xname);
379 (void)ng_name_node(node, ifname);
382 /* Attach the interface */
383 ether_ifattach(ifp, eaddr, NULL);
390 * Give our ok for a hook to be added
393 ng_eiface_newhook(node_p node, hook_p hook, const char *name)
395 priv_p priv = NG_NODE_PRIVATE(node);
396 struct ifnet *ifp = priv->ifp;
398 if (strcmp(name, NG_EIFACE_HOOK_ETHER))
399 return (EPFNOSUPPORT);
400 if (priv->ether != NULL)
403 NG_HOOK_SET_PRIVATE(hook, &priv->ether);
405 ifp->if_link_state = LINK_STATE_UP;
406 if_link_state_change(ifp);
412 * Receive a control message
415 ng_eiface_rcvmsg(node_p node, item_p item, hook_p lasthook)
417 const priv_p priv = NG_NODE_PRIVATE(node);
418 struct ifnet *const ifp = priv->ifp;
419 struct ng_mesg *resp = NULL;
423 NGI_GET_MSG(item, msg);
424 switch (msg->header.typecookie) {
425 case NGM_EIFACE_COOKIE:
426 switch (msg->header.cmd) {
430 if (msg->header.arglen != ETHER_ADDR_LEN) {
434 error = if_setlladdr(priv->ifp,
435 (u_char *)msg->data, ETHER_ADDR_LEN);
439 case NGM_EIFACE_GET_IFNAME:
440 NG_MKRESPONSE(resp, msg, IFNAMSIZ, M_WAITOK | M_NULLOK);
445 strlcpy(resp->data, ifp->if_xname, IFNAMSIZ);
448 case NGM_EIFACE_GET_IFADDRS:
450 struct ifaddr_container *ifac;
454 #define SA_SIZE(s) RT_ROUNDUP((s)->sa_len)
456 /* Determine size of response and allocate it */
458 TAILQ_FOREACH(ifac, &ifp->if_addrheads[mycpuid],
460 buflen += SA_SIZE(ifac->ifa->ifa_addr);
461 NG_MKRESPONSE(resp, msg, buflen, M_WAITOK | M_NULLOK);
469 TAILQ_FOREACH(ifac, &ifp->if_addrheads[mycpuid],
471 struct ifaddr *ifa = ifac->ifa;
472 const int len = SA_SIZE(ifa->ifa_addr);
475 log(LOG_ERR, "%s: len changed?\n",
479 bcopy(ifa->ifa_addr, ptr, len);
490 } /* end of inner switch() */
492 case NGM_FLOW_COOKIE:
493 switch (msg->header.cmd) {
495 ifp->if_link_state = LINK_STATE_UP;
496 if_link_state_change(ifp);
498 case NGM_LINK_IS_DOWN:
499 ifp->if_link_state = LINK_STATE_DOWN;
500 if_link_state_change(ifp);
510 NG_RESPOND_MSG(error, node, item, resp);
516 * Receive data from a hook. Pass the packet to the ether_input routine.
519 ng_eiface_rcvdata(hook_p hook, item_p item)
521 const priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
522 struct ifnet *const ifp = priv->ifp;
528 if (!((ifp->if_flags & IFF_UP) &&
529 (ifp->if_flags & IFF_RUNNING))) {
534 if (m->m_len < ETHER_HDR_LEN) {
535 m = m_pullup(m, ETHER_HDR_LEN);
540 /* Note receiving interface */
541 m->m_pkthdr.rcvif = ifp;
543 /* Update interface stats */
546 ifp->if_input(ifp, m, NULL, -1);
553 * Shutdown processing.
556 ng_eiface_rmnode(node_p node)
558 const priv_p priv = NG_NODE_PRIVATE(node);
559 struct ifnet *const ifp = priv->ifp;
563 kfree(priv, M_NETGRAPH);
564 NG_NODE_SET_PRIVATE(node, NULL);
573 ng_eiface_disconnect(hook_p hook)
575 const priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
582 * Handle loading and unloading for this node type.
585 ng_eiface_mod_event(module_t mod, int event, void *data)