4 * Copyright (c) 1999-2000, Vitaly V Belekhov
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice unmodified, this list of conditions, and the following
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * $Id: ng_eiface.c,v 1.14 2000/03/15 12:28:44 vitaly Exp $
30 * $FreeBSD: src/sys/netgraph/ng_eiface.c,v 1.4.2.5 2002/12/17 21:47:48 julian Exp $
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/errno.h>
36 #include <sys/kernel.h>
37 #include <sys/malloc.h>
39 #include <sys/errno.h>
40 #include <sys/sockio.h>
41 #include <sys/socket.h>
42 #include <sys/syslog.h>
43 #include <sys/serialize.h>
44 #include <sys/thread2.h>
47 #include <net/if_types.h>
48 #include <net/ifq_var.h>
49 #include <net/netisr.h>
52 #include <netgraph/ng_message.h>
53 #include <netgraph/netgraph.h>
54 #include <netgraph/ng_parse.h>
55 #include "ng_eiface.h"
58 #include <net/ethernet.h>
59 #include <net/if_arp.h>
61 static const struct ng_parse_struct_field ng_eiface_par_fields[]
62 = NG_EIFACE_PAR_FIELDS;
64 static const struct ng_parse_type ng_eiface_par_type = {
65 &ng_parse_struct_type,
69 static const struct ng_cmdlist ng_eiface_cmdlist[] = {
80 /* Node private data */
81 struct ng_eiface_private {
82 struct arpcom arpcom; /* per-interface network data */
83 struct ifnet *ifp; /* This interface */
84 node_p node; /* Our netgraph node */
85 hook_p ether; /* Hook for ethernet stream */
86 struct private *next; /* When hung on the free list */
88 typedef struct ng_eiface_private *priv_p;
90 /* Interface methods */
91 static void ng_eiface_init(void *xsc);
92 static void ng_eiface_start(struct ifnet *ifp, struct ifaltq_subque *);
93 static int ng_eiface_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data,
96 static void ng_eiface_print_ioctl(struct ifnet *ifp, int cmd, caddr_t data);
99 /* Netgraph methods */
100 static ng_constructor_t ng_eiface_constructor;
101 static ng_rcvmsg_t ng_eiface_rcvmsg;
102 static ng_shutdown_t ng_eiface_rmnode;
103 static ng_newhook_t ng_eiface_newhook;
104 static ng_rcvdata_t ng_eiface_rcvdata;
105 static ng_connect_t ng_eiface_connect;
106 static ng_disconnect_t ng_eiface_disconnect;
108 /* Node type descriptor */
109 static struct ng_type typestruct = {
113 ng_eiface_constructor,
121 ng_eiface_disconnect,
124 NETGRAPH_INIT(eiface, &typestruct);
126 static char ng_eiface_ifname[] = NG_EIFACE_EIFACE_NAME;
127 static int ng_eiface_next_unit;
129 /************************************************************************
131 ************************************************************************/
134 * Process an ioctl for the virtual interface
137 ng_eiface_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
139 struct ifreq *const ifr = (struct ifreq *) data;
143 ng_eiface_print_ioctl(ifp, cmd, data);
148 /* These two are mostly handled at a higher layer */
150 error = ether_ioctl(ifp, cmd, data);
158 * If the interface is marked up and stopped, then start it.
159 * If it is marked down and running, then stop it.
161 if (ifr->ifr_flags & IFF_UP) {
162 if (!(ifp->if_flags & IFF_RUNNING)) {
163 ifq_clr_oactive(&ifp->if_snd);
164 ifp->if_flags |= IFF_RUNNING;
167 if (ifp->if_flags & IFF_RUNNING) {
168 ifp->if_flags &= ~IFF_RUNNING;
169 ifq_clr_oactive(&ifp->if_snd);
174 /* Set the interface MTU */
176 if (ifr->ifr_mtu > NG_EIFACE_MTU_MAX
177 || ifr->ifr_mtu < NG_EIFACE_MTU_MIN)
180 ifp->if_mtu = ifr->ifr_mtu;
183 /* Stuff that's not supported */
201 ng_eiface_init(void *xsc)
204 struct ifnet *ifp = sc->ifp;
208 ifp->if_flags |= IFF_RUNNING;
209 ifq_clr_oactive(&ifp->if_snd);
216 * This routine is called to deliver a packet out the interface.
217 * We simply relay the packet to
218 * the ether hook, if it is connected.
222 ng_eiface_start(struct ifnet *ifp, struct ifaltq_subque *ifsq __unused)
224 const priv_p priv = (priv_p) ifp->if_softc;
229 /* Check interface flags */
230 if ((ifp->if_flags & (IFF_UP|IFF_RUNNING)) != (IFF_UP|IFF_RUNNING))
233 /* Don't do anything if output is active */
234 if(ifq_is_oactive(&ifp->if_snd))
237 ifq_set_oactive(&ifp->if_snd);
240 * Grab a packet to transmit.
242 m = ifq_dequeue(&ifp->if_snd, NULL);
244 /* If there's nothing to send, return. */
247 ifq_clr_oactive(&ifp->if_snd);
253 /* Copy length before the mbuf gets invalidated */
254 len = m->m_pkthdr.len;
256 /* Send packet; if hook is not connected, mbuf will get freed. */
257 NG_SEND_DATA(error, priv->ether, m, meta);
261 ifp->if_obytes += len;
265 ifq_clr_oactive(&ifp->if_snd);
272 * Display an ioctl to the virtual interface
276 ng_eiface_print_ioctl(struct ifnet *ifp, int cmd, caddr_t data)
280 switch (cmd & IOC_DIRMASK) {
296 log(LOG_DEBUG, "%s: %s('%c', %d, char[%d])\n",
305 /************************************************************************
307 ************************************************************************/
310 * Constructor for a node
313 ng_eiface_constructor(node_p *nodep)
320 /* Allocate node and interface private structures */
321 priv = kmalloc(sizeof(*priv), M_NETGRAPH, M_WAITOK | M_ZERO);
323 ifp = &(priv->arpcom.ac_if);
325 /* Link them together */
326 ifp->if_softc = priv;
329 /* Call generic node constructor */
330 if ((error = ng_make_node_common(&typestruct, nodep))) {
331 kfree(priv, M_NETGRAPH);
336 /* Link together node and private info */
337 node->private = priv;
340 /* Initialize interface structure */
341 if_initname(ifp, ng_eiface_ifname, ng_eiface_next_unit++);
342 ifp->if_init = ng_eiface_init;
343 ifp->if_start = ng_eiface_start;
344 ifp->if_ioctl = ng_eiface_ioctl;
345 ifp->if_watchdog = NULL;
346 ifq_set_maxlen(&ifp->if_snd, IFQ_MAXLEN);
347 ifp->if_flags = (IFF_SIMPLEX | IFF_BROADCAST | IFF_MULTICAST);
349 /* Give this node name *
350 bzero(ifname, sizeof(ifname));
351 ksprintf(ifname, "if%s", ifp->if_xname);
352 ng_name_node(node, ifname);
355 /* Attach the interface */
356 ether_ifattach(ifp, priv->arpcom.ac_enaddr, NULL);
363 * Give our ok for a hook to be added
366 ng_eiface_newhook(node_p node, hook_p hook, const char *name)
368 priv_p priv = node->private;
370 if (strcmp(name, NG_EIFACE_HOOK_ETHER))
371 return (EPFNOSUPPORT);
372 if (priv->ether != NULL)
375 hook->private = &priv->ether;
381 * Receive a control message
384 ng_eiface_rcvmsg(node_p node, struct ng_mesg *msg,
385 const char *retaddr, struct ng_mesg **rptr)
387 const priv_p priv = node->private;
388 struct ifnet *const ifp = priv->ifp;
389 struct ng_mesg *resp = NULL;
392 switch (msg->header.typecookie) {
393 case NGM_EIFACE_COOKIE:
394 switch (msg->header.cmd) {
398 struct ng_eiface_par *eaddr;
400 if (msg->header.arglen != sizeof(struct ng_eiface_par))
405 eaddr = (struct ng_eiface_par *)(msg->data);
407 priv->arpcom.ac_enaddr[0] = eaddr->oct0;
408 priv->arpcom.ac_enaddr[1] = eaddr->oct1;
409 priv->arpcom.ac_enaddr[2] = eaddr->oct2;
410 priv->arpcom.ac_enaddr[3] = eaddr->oct3;
411 priv->arpcom.ac_enaddr[4] = eaddr->oct4;
412 priv->arpcom.ac_enaddr[5] = eaddr->oct5;
417 case NGM_EIFACE_GET_IFNAME:
419 struct ng_eiface_ifname *arg;
421 NG_MKRESPONSE(resp, msg, sizeof(*arg), M_NOWAIT);
426 arg = (struct ng_eiface_ifname *) resp->data;
427 ksprintf(arg->ngif_name,
428 "%s", ifp->if_xname); /* XXX: strings */
432 case NGM_EIFACE_GET_IFADDRS:
434 struct ifaddr_container *ifac;
438 #define SA_SIZE(s) ((s)->sa_len<sizeof(*(s))? sizeof(*(s)):(s)->sa_len)
440 /* Determine size of response and allocate it */
442 TAILQ_FOREACH(ifac, &ifp->if_addrheads[mycpuid],
444 buflen += SA_SIZE(ifac->ifa->ifa_addr);
445 NG_MKRESPONSE(resp, msg, buflen, M_NOWAIT);
453 TAILQ_FOREACH(ifac, &ifp->if_addrheads[mycpuid],
455 struct ifaddr *ifa = ifac->ifa;
456 const int len = SA_SIZE(ifa->ifa_addr);
459 log(LOG_ERR, "%s: len changed?\n",
463 bcopy(ifa->ifa_addr, ptr, len);
483 kfree(resp, M_NETGRAPH);
484 kfree(msg, M_NETGRAPH);
489 * Recive data from a hook. Pass the packet to the ether_input routine.
492 ng_eiface_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
494 const priv_p priv = hook->node->private;
495 struct ifnet *const ifp = priv->ifp;
498 /* Meta-data is end its life here... */
502 kprintf("ng_eiface: mbuf is null.\n");
506 if ( !(ifp->if_flags & IFF_UP) )
509 /* Note receiving interface */
510 m->m_pkthdr.rcvif = ifp;
512 /* Update interface stats */
517 ifp->if_input(ifp, m);
524 * Because the BSD networking code doesn't support the removal of
525 * networking interfaces, iface nodes (once created) are persistent.
526 * So this method breaks all connections and marks the interface
527 * down, but does not remove the node.
530 ng_eiface_rmnode(node_p node)
532 const priv_p priv = node->private;
533 struct ifnet *const ifp = priv->ifp;
536 node->flags &= ~NG_INVALID;
537 ifnet_serialize_all(ifp);
538 ifp->if_flags &= ~(IFF_UP | IFF_RUNNING);
539 ifq_clr_oactive(&ifp->if_snd);
540 ifnet_deserialize_all(ifp);
546 * This is called once we've already connected a new hook to the other node.
547 * It gives us a chance to balk at the last minute.
550 ng_eiface_connect(hook_p hook)
552 /* be really amiable and just say "YUP that's OK by me! " */
560 ng_eiface_disconnect(hook_p hook)
562 const priv_p priv = hook->node->private;