xref: /dflybsd-src/sys/netgraph/eiface/ng_eiface.c (revision e7b4468ce80913950cd099c393f3ce6ece6fcb2c) 
1 /*
2  * ng_eiface.c
3  *
4  * Copyright (c) 1999-2000, Vitaly V Belekhov
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice unmodified, this list of conditions, and the following
12  *    disclaimer.
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.
16  *
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
27  * SUCH DAMAGE.
28  *
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 $
31  * $DragonFly: src/sys/netgraph/eiface/ng_eiface.c,v 1.15 2008/01/05 14:02:39 swildner Exp $
32  */
33 
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/errno.h>
37 #include <sys/kernel.h>
38 #include <sys/malloc.h>
39 #include <sys/mbuf.h>
40 #include <sys/errno.h>
41 #include <sys/sockio.h>
42 #include <sys/socket.h>
43 #include <sys/syslog.h>
44 #include <sys/serialize.h>
45 #include <sys/thread2.h>
46 
47 #include <net/if.h>
48 #include <net/if_types.h>
49 #include <net/netisr.h>
50 
51 
52 #include <netgraph/ng_message.h>
53 #include <netgraph/netgraph.h>
54 #include <netgraph/ng_parse.h>
55 #include "ng_eiface.h"
56 
57 #include <net/bpf.h>
58 #include <net/ethernet.h>
59 #include <net/if_arp.h>
60 
61 static const struct ng_parse_struct_field ng_eiface_par_fields[]
62 	= NG_EIFACE_PAR_FIELDS;
63 
64 static const struct ng_parse_type ng_eiface_par_type = {
65 	&ng_parse_struct_type,
66 	&ng_eiface_par_fields
67 };
68 
69 static const struct ng_cmdlist ng_eiface_cmdlist[] = {
70 	{
71 	  NGM_EIFACE_COOKIE,
72 	  NGM_EIFACE_SET,
73 	  "set",
74 	  &ng_eiface_par_type,
75 	  NULL
76 	},
77 	{ 0 }
78 };
79 
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 */
87 };
88 typedef struct ng_eiface_private *priv_p;
89 
90 /* Interface methods */
91 static void	ng_eiface_init(void *xsc);
92 static void	ng_eiface_start(struct ifnet *ifp);
93 static int	ng_eiface_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data,
94 				struct ucred *cr);
95 #ifdef DEBUG
96 static void	ng_eiface_print_ioctl(struct ifnet *ifp, int cmd, caddr_t data);
97 #endif
98 
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;
107 
108 /* Node type descriptor */
109 static struct ng_type typestruct = {
110 	NG_VERSION,
111 	NG_EIFACE_NODE_TYPE,
112 	NULL,
113 	ng_eiface_constructor,
114 	ng_eiface_rcvmsg,
115 	ng_eiface_rmnode,
116 	ng_eiface_newhook,
117 	NULL,
118 	ng_eiface_connect,
119 	ng_eiface_rcvdata,
120 	ng_eiface_rcvdata,
121 	ng_eiface_disconnect,
122 	ng_eiface_cmdlist
123 };
124 NETGRAPH_INIT(eiface, &typestruct);
125 
126 static char ng_eiface_ifname[] = NG_EIFACE_EIFACE_NAME;
127 static int ng_eiface_next_unit;
128 
129 /************************************************************************
130 			INTERFACE STUFF
131  ************************************************************************/
132 
133 /*
134  * Process an ioctl for the virtual interface
135  */
136 static int
137 ng_eiface_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
138 {
139 	struct ifreq *const ifr = (struct ifreq *) data;
140 	int error = 0;
141 
142 #ifdef DEBUG
143 	ng_eiface_print_ioctl(ifp, cmd, data);
144 #endif
145 	crit_enter();
146 	switch (cmd) {
147 
148 	/* These two are mostly handled at a higher layer */
149 	case SIOCSIFADDR:
150 		error = ether_ioctl(ifp, cmd, data);
151 		break;
152 	case SIOCGIFADDR:
153 		break;
154 
155 	/* Set flags */
156 	case SIOCSIFFLAGS:
157 		/*
158 		 * If the interface is marked up and stopped, then start it.
159 		 * If it is marked down and running, then stop it.
160 		 */
161 		if (ifr->ifr_flags & IFF_UP) {
162 			if (!(ifp->if_flags & IFF_RUNNING)) {
163 				ifp->if_flags &= ~(IFF_OACTIVE);
164 				ifp->if_flags |= IFF_RUNNING;
165 			}
166 		} else {
167 			if (ifp->if_flags & IFF_RUNNING)
168 				ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
169 		}
170 		break;
171 
172 	/* Set the interface MTU */
173 	case SIOCSIFMTU:
174 		if (ifr->ifr_mtu > NG_EIFACE_MTU_MAX
175 		    || ifr->ifr_mtu < NG_EIFACE_MTU_MIN)
176 			error = EINVAL;
177 		else
178 			ifp->if_mtu = ifr->ifr_mtu;
179 		break;
180 
181 	/* Stuff that's not supported */
182 	case SIOCADDMULTI:
183 	case SIOCDELMULTI:
184 		error = 0;
185 		break;
186 	case SIOCSIFPHYS:
187 		error = EOPNOTSUPP;
188 		break;
189 
190 	default:
191 		error = EINVAL;
192 		break;
193 	}
194 	crit_exit();
195 	return (error);
196 }
197 
198 static void
199 ng_eiface_init(void *xsc)
200 {
201 	priv_p sc = xsc;
202 	struct ifnet *ifp = sc->ifp;
203 
204 	crit_enter();
205 
206 	ifp->if_flags |= IFF_RUNNING;
207 	ifp->if_flags &= ~IFF_OACTIVE;
208 
209 	crit_exit();
210 
211 }
212 
213 /*
214  * This routine is called to deliver a packet out the interface.
215  * We simply relay the packet to
216  * the ether hook, if it is connected.
217  */
218 
219 static void
220 ng_eiface_start(struct ifnet *ifp)
221 {
222 	const priv_p priv = (priv_p) ifp->if_softc;
223 	meta_p meta = NULL;
224 	int len, error = 0;
225 	struct mbuf *m;
226 
227 	/* Check interface flags */
228 	if ((ifp->if_flags & (IFF_UP|IFF_RUNNING)) != (IFF_UP|IFF_RUNNING))
229 		return;
230 
231 	/* Don't do anything if output is active */
232 	if( ifp->if_flags & IFF_OACTIVE )
233 		return;
234 
235 	ifp->if_flags |= IFF_OACTIVE;
236 
237 	/*
238 	 * Grab a packet to transmit.
239 	 */
240 	IF_DEQUEUE(&ifp->if_snd, m);
241 
242 	/* If there's nothing to send, return. */
243 	if(m == NULL)
244 	{
245 		ifp->if_flags &= ~IFF_OACTIVE;
246 		return;
247 	}
248 
249 	BPF_MTAP(ifp, m);
250 
251 	/* Copy length before the mbuf gets invalidated */
252 	len = m->m_pkthdr.len;
253 
254 	/* Send packet; if hook is not connected, mbuf will get freed. */
255 	NG_SEND_DATA(error, priv->ether, m, meta);
256 
257 	/* Update stats */
258 	if (error == 0) {
259 		ifp->if_obytes += len;
260 		ifp->if_opackets++;
261 	}
262 
263 	ifp->if_flags &= ~IFF_OACTIVE;
264 
265 	return;
266 }
267 
268 #ifdef DEBUG
269 /*
270  * Display an ioctl to the virtual interface
271  */
272 
273 static void
274 ng_eiface_print_ioctl(struct ifnet *ifp, int cmd, caddr_t data)
275 {
276 	char   *str;
277 
278 	switch (cmd & IOC_DIRMASK) {
279 	case IOC_VOID:
280 		str = "IO";
281 		break;
282 	case IOC_OUT:
283 		str = "IOR";
284 		break;
285 	case IOC_IN:
286 		str = "IOW";
287 		break;
288 	case IOC_INOUT:
289 		str = "IORW";
290 		break;
291 	default:
292 		str = "IO??";
293 	}
294 	log(LOG_DEBUG, "%s: %s('%c', %d, char[%d])\n",
295 	       ifp->if_xname,
296 	       str,
297 	       IOCGROUP(cmd),
298 	       cmd & 0xff,
299 	       IOCPARM_LEN(cmd));
300 }
301 #endif /* DEBUG */
302 
303 /************************************************************************
304 			NETGRAPH NODE STUFF
305  ************************************************************************/
306 
307 /*
308  * Constructor for a node
309  */
310 static int
311 ng_eiface_constructor(node_p *nodep)
312 {
313 	struct ifnet *ifp;
314 	node_p node;
315 	priv_p priv;
316 	int error = 0;
317 
318 	/* Allocate node and interface private structures */
319 	MALLOC(priv, priv_p, sizeof(*priv), M_NETGRAPH, M_WAITOK | M_ZERO);
320 	if (priv == NULL)
321 		return (ENOMEM);
322 
323 	ifp = &(priv->arpcom.ac_if);
324 
325 	/* Link them together */
326 	ifp->if_softc = priv;
327 	priv->ifp = ifp;
328 
329 	/* Call generic node constructor */
330 	if ((error = ng_make_node_common(&typestruct, nodep))) {
331 		FREE(priv, M_NETGRAPH);
332 		return (error);
333 	}
334 	node = *nodep;
335 
336 	/* Link together node and private info */
337 	node->private = priv;
338 	priv->node = node;
339 
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 	ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
347 	ifp->if_flags = (IFF_SIMPLEX | IFF_BROADCAST | IFF_MULTICAST);
348 
349 	TAILQ_INIT(&ifp->if_addrhead);
350 
351 	/* Give this node name *
352 	bzero(ifname, sizeof(ifname));
353 	ksprintf(ifname, "if%s", ifp->if_xname);
354 	ng_name_node(node, ifname);
355 	*/
356 
357 	/* Attach the interface */
358 	ether_ifattach(ifp, priv->arpcom.ac_enaddr, NULL);
359 
360 	/* Done */
361 	return (0);
362 }
363 
364 /*
365  * Give our ok for a hook to be added
366  */
367 static int
368 ng_eiface_newhook(node_p node, hook_p hook, const char *name)
369 {
370 	priv_p priv = node->private;
371 
372 	if (strcmp(name, NG_EIFACE_HOOK_ETHER))
373 		return (EPFNOSUPPORT);
374 	if (priv->ether != NULL)
375 		return (EISCONN);
376 	priv->ether = hook;
377 	hook->private = &priv->ether;
378 
379 	return (0);
380 }
381 
382 /*
383  * Receive a control message
384  */
385 static int
386 ng_eiface_rcvmsg(node_p node, struct ng_mesg *msg,
387 		const char *retaddr, struct ng_mesg **rptr)
388 {
389 	const priv_p priv = node->private;
390 	struct ifnet *const ifp = priv->ifp;
391 	struct ng_mesg *resp = NULL;
392 	int error = 0;
393 
394 	switch (msg->header.typecookie) {
395 	case NGM_EIFACE_COOKIE:
396 		switch (msg->header.cmd) {
397 
398 		case NGM_EIFACE_SET:
399 		    {
400 		      struct ng_eiface_par *eaddr;
401 
402 		      if (msg->header.arglen != sizeof(struct ng_eiface_par))
403 			{
404 			  error = EINVAL;
405 			  break;
406 			}
407 		      eaddr = (struct ng_eiface_par *)(msg->data);
408 
409 		      priv->arpcom.ac_enaddr[0] = eaddr->oct0;
410 		      priv->arpcom.ac_enaddr[1] = eaddr->oct1;
411 		      priv->arpcom.ac_enaddr[2] = eaddr->oct2;
412 		      priv->arpcom.ac_enaddr[3] = eaddr->oct3;
413 		      priv->arpcom.ac_enaddr[4] = eaddr->oct4;
414 		      priv->arpcom.ac_enaddr[5] = eaddr->oct5;
415 
416 		      break;
417 		    }
418 
419 		case NGM_EIFACE_GET_IFNAME:
420 		    {
421 			struct ng_eiface_ifname *arg;
422 
423 			NG_MKRESPONSE(resp, msg, sizeof(*arg), M_NOWAIT);
424 			if (resp == NULL) {
425 				error = ENOMEM;
426 				break;
427 			}
428 			arg = (struct ng_eiface_ifname *) resp->data;
429 			ksprintf(arg->ngif_name,
430 			    "%s", ifp->if_xname); /* XXX: strings */
431 			break;
432 		    }
433 
434 		case NGM_EIFACE_GET_IFADDRS:
435 		    {
436 			struct ifaddr *ifa;
437 			caddr_t ptr;
438 			int buflen;
439 
440 #define SA_SIZE(s)	((s)->sa_len<sizeof(*(s))? sizeof(*(s)):(s)->sa_len)
441 
442 			/* Determine size of response and allocate it */
443 			buflen = 0;
444 			TAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link)
445 				buflen += SA_SIZE(ifa->ifa_addr);
446 			NG_MKRESPONSE(resp, msg, buflen, M_NOWAIT);
447 			if (resp == NULL) {
448 				error = ENOMEM;
449 				break;
450 			}
451 
452 			/* Add addresses */
453 			ptr = resp->data;
454 			TAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) {
455 				const int len = SA_SIZE(ifa->ifa_addr);
456 
457 				if (buflen < len) {
458 					log(LOG_ERR, "%s: len changed?\n",
459 					    ifp->if_xname);
460 					break;
461 				}
462 				bcopy(ifa->ifa_addr, ptr, len);
463 				ptr += len;
464 				buflen -= len;
465 			}
466 			break;
467 #undef SA_SIZE
468 		    }
469 
470 		default:
471 			error = EINVAL;
472 			break;
473 		}
474 		break;
475 	default:
476 		error = EINVAL;
477 		break;
478 	}
479 	if (rptr)
480 		*rptr = resp;
481 	else if (resp)
482 		FREE(resp, M_NETGRAPH);
483 	FREE(msg, M_NETGRAPH);
484 	return (error);
485 }
486 
487 /*
488  * Recive data from a hook. Pass the packet to the ether_input routine.
489  */
490 static int
491 ng_eiface_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
492 {
493 	const priv_p priv = hook->node->private;
494 	struct ifnet *const ifp = priv->ifp;
495 	int error = 0;
496 
497 	/* Meta-data is end its life here... */
498 	NG_FREE_META(meta);
499 
500 	if (m == NULL)
501 	  {
502 	    kprintf("ng_eiface: mbuf is null.\n");
503 	    return (EINVAL);
504 	  }
505 
506 	lwkt_serialize_enter(ifp->if_serializer);
507 	if ( !(ifp->if_flags & IFF_UP) ) {
508 		lwkt_serialize_exit(ifp->if_serializer);
509 		return (ENETDOWN);
510 	}
511 
512 	/* Note receiving interface */
513 	m->m_pkthdr.rcvif = ifp;
514 
515 	/* Update interface stats */
516 	ifp->if_ipackets++;
517 
518 	BPF_MTAP(ifp, m);
519 
520 	ifp->if_input(ifp, m);
521 	lwkt_serialize_exit(ifp->if_serializer);
522 
523 	/* Done */
524 	return (error);
525 }
526 
527 /*
528  * Because the BSD networking code doesn't support the removal of
529  * networking interfaces, iface nodes (once created) are persistent.
530  * So this method breaks all connections and marks the interface
531  * down, but does not remove the node.
532  */
533 static int
534 ng_eiface_rmnode(node_p node)
535 {
536 	const priv_p priv = node->private;
537 	struct ifnet *const ifp = priv->ifp;
538 
539 	ng_cutlinks(node);
540 	node->flags &= ~NG_INVALID;
541 	lwkt_serialize_enter(ifp->if_serializer);
542 	ifp->if_flags &= ~(IFF_UP | IFF_RUNNING | IFF_OACTIVE);
543 	lwkt_serialize_exit(ifp->if_serializer);
544 	return (0);
545 }
546 
547 
548 /*
549  * This is called once we've already connected a new hook to the other node.
550  * It gives us a chance to balk at the last minute.
551  */
552 static int
553 ng_eiface_connect(hook_p hook)
554 {
555 	/* be really amiable and just say "YUP that's OK by me! " */
556 	return (0);
557 }
558 
559 /*
560  * Hook disconnection
561  */
562 static int
563 ng_eiface_disconnect(hook_p hook)
564 {
565 	const priv_p priv = hook->node->private;
566 
567 	priv->ether = NULL;
568 	return (0);
569 }
570