5 * Copyright (c) 1996-1999 Whistle Communications, Inc.
8 * Subject to the following obligations and disclaimer of warranty, use and
9 * redistribution of this software, in source or object code forms, with or
10 * without modifications are expressly permitted by Whistle Communications;
11 * provided, however, that:
12 * 1. Any and all reproductions of the source or object code must include the
13 * copyright notice above and the following disclaimer of warranties; and
14 * 2. No rights are granted, in any manner or form, to use Whistle
15 * Communications, Inc. trademarks, including the mark "WHISTLE
16 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
17 * such appears in the above copyright notice or in the software.
19 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
20 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
21 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
22 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
23 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
24 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
25 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
26 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
27 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
28 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
29 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
30 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
31 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
37 * Author: Archie Cobbs <archie@freebsd.org>
39 * $FreeBSD: src/sys/netgraph/ng_iface.c,v 1.7.2.5 2002/07/02 23:44:02 archie Exp $
40 * $DragonFly: src/sys/netgraph/iface/ng_iface.c,v 1.5 2003/09/16 06:25:35 hsu Exp $
41 * $Whistle: ng_iface.c,v 1.33 1999/11/01 09:24:51 julian Exp $
45 * This node is also a system networking interface. It has
46 * a hook for each protocol (IP, AppleTalk, IPX, etc). Packets
47 * are simply relayed between the interface and the hooks.
49 * Interfaces are named ng0, ng1, etc. New nodes take the
50 * first available interface name.
52 * This node also includes Berkeley packet filter support.
55 #include "opt_atalk.h"
57 #include "opt_inet6.h"
60 #include <sys/param.h>
61 #include <sys/systm.h>
62 #include <sys/errno.h>
63 #include <sys/kernel.h>
64 #include <sys/malloc.h>
66 #include <sys/errno.h>
67 #include <sys/sockio.h>
68 #include <sys/socket.h>
69 #include <sys/syslog.h>
70 #include <sys/libkern.h>
73 #include <net/if_types.h>
74 #include <net/netisr.h>
77 #include <netinet/in.h>
79 #include <netgraph/ng_message.h>
80 #include <netgraph/netgraph.h>
81 #include <netgraph/ng_parse.h>
83 #include <netgraph/cisco/ng_cisco.h>
85 /* This struct describes one address family */
87 sa_family_t family; /* Address family */
88 const char *hookname; /* Name for hook */
90 typedef const struct iffam *iffam_p;
92 /* List of address families supported by our interface */
93 const static struct iffam gFamilies[] = {
94 { AF_INET, NG_IFACE_HOOK_INET },
95 { AF_INET6, NG_IFACE_HOOK_INET6 },
96 { AF_APPLETALK, NG_IFACE_HOOK_ATALK },
97 { AF_IPX, NG_IFACE_HOOK_IPX },
98 { AF_ATM, NG_IFACE_HOOK_ATM },
99 { AF_NATM, NG_IFACE_HOOK_NATM },
100 { AF_NS, NG_IFACE_HOOK_NS },
102 #define NUM_FAMILIES (sizeof(gFamilies) / sizeof(*gFamilies))
104 /* Node private data */
105 struct ng_iface_private {
106 struct ifnet *ifp; /* Our interface */
107 int unit; /* Interface unit number */
108 node_p node; /* Our netgraph node */
109 hook_p hooks[NUM_FAMILIES]; /* Hook for each address family */
111 typedef struct ng_iface_private *priv_p;
113 /* Interface methods */
114 static void ng_iface_start(struct ifnet *ifp);
115 static int ng_iface_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data);
116 static int ng_iface_output(struct ifnet *ifp, struct mbuf *m0,
117 struct sockaddr *dst, struct rtentry *rt0);
118 static void ng_iface_bpftap(struct ifnet *ifp,
119 struct mbuf *m, sa_family_t family);
121 static void ng_iface_print_ioctl(struct ifnet *ifp, int cmd, caddr_t data);
124 /* Netgraph methods */
125 static ng_constructor_t ng_iface_constructor;
126 static ng_rcvmsg_t ng_iface_rcvmsg;
127 static ng_shutdown_t ng_iface_rmnode;
128 static ng_newhook_t ng_iface_newhook;
129 static ng_rcvdata_t ng_iface_rcvdata;
130 static ng_disconnect_t ng_iface_disconnect;
133 static iffam_p get_iffam_from_af(sa_family_t family);
134 static iffam_p get_iffam_from_hook(priv_p priv, hook_p hook);
135 static iffam_p get_iffam_from_name(const char *name);
136 static hook_p *get_hook_from_iffam(priv_p priv, iffam_p iffam);
138 /* Parse type for struct ng_iface_ifname */
139 static const struct ng_parse_fixedstring_info ng_iface_ifname_info = {
140 NG_IFACE_IFACE_NAME_MAX + 1
142 static const struct ng_parse_type ng_iface_ifname_type = {
143 &ng_parse_fixedstring_type,
144 &ng_iface_ifname_info
147 /* Parse type for struct ng_cisco_ipaddr */
148 static const struct ng_parse_struct_field ng_cisco_ipaddr_type_fields[]
149 = NG_CISCO_IPADDR_TYPE_INFO;
150 static const struct ng_parse_type ng_cisco_ipaddr_type = {
151 &ng_parse_struct_type,
152 &ng_cisco_ipaddr_type_fields
155 /* List of commands and how to convert arguments to/from ASCII */
156 static const struct ng_cmdlist ng_iface_cmds[] = {
159 NGM_IFACE_GET_IFNAME,
162 &ng_iface_ifname_type
166 NGM_IFACE_POINT2POINT,
180 NGM_CISCO_GET_IPADDR,
183 &ng_cisco_ipaddr_type
188 /* Node type descriptor */
189 static struct ng_type typestruct = {
193 ng_iface_constructor,
204 NETGRAPH_INIT(iface, &typestruct);
206 /* We keep a bitmap indicating which unit numbers are free.
207 One means the unit number is free, zero means it's taken. */
208 static int *ng_iface_units = NULL;
209 static int ng_iface_units_len = 0;
211 #define UNITS_BITSPERWORD (sizeof(*ng_iface_units) * NBBY)
213 /************************************************************************
215 ************************************************************************/
218 * Get the family descriptor from the family ID
220 static __inline__ iffam_p
221 get_iffam_from_af(sa_family_t family)
226 for (k = 0; k < NUM_FAMILIES; k++) {
227 iffam = &gFamilies[k];
228 if (iffam->family == family)
235 * Get the family descriptor from the hook
237 static __inline__ iffam_p
238 get_iffam_from_hook(priv_p priv, hook_p hook)
242 for (k = 0; k < NUM_FAMILIES; k++)
243 if (priv->hooks[k] == hook)
244 return (&gFamilies[k]);
249 * Get the hook from the iffam descriptor
252 static __inline__ hook_p *
253 get_hook_from_iffam(priv_p priv, iffam_p iffam)
255 return (&priv->hooks[iffam - gFamilies]);
259 * Get the iffam descriptor from the name
261 static __inline__ iffam_p
262 get_iffam_from_name(const char *name)
267 for (k = 0; k < NUM_FAMILIES; k++) {
268 iffam = &gFamilies[k];
269 if (!strcmp(iffam->hookname, name))
276 * Find the first free unit number for a new interface.
277 * Increase the size of the unit bitmap as necessary.
279 static __inline__ int
280 ng_iface_get_unit(int *unit)
284 for (index = 0; index < ng_iface_units_len
285 && ng_iface_units[index] == 0; index++);
286 if (index == ng_iface_units_len) { /* extend array */
287 int i, *newarray, newlen;
289 newlen = (2 * ng_iface_units_len) + 4;
290 MALLOC(newarray, int *, newlen * sizeof(*ng_iface_units),
291 M_NETGRAPH, M_NOWAIT);
292 if (newarray == NULL)
294 bcopy(ng_iface_units, newarray,
295 ng_iface_units_len * sizeof(*ng_iface_units));
296 for (i = ng_iface_units_len; i < newlen; i++)
298 if (ng_iface_units != NULL)
299 FREE(ng_iface_units, M_NETGRAPH);
300 ng_iface_units = newarray;
301 ng_iface_units_len = newlen;
303 bit = ffs(ng_iface_units[index]) - 1;
304 KASSERT(bit >= 0 && bit <= UNITS_BITSPERWORD - 1,
305 ("%s: word=%d bit=%d", __FUNCTION__, ng_iface_units[index], bit));
306 ng_iface_units[index] &= ~(1 << bit);
307 *unit = (index * UNITS_BITSPERWORD) + bit;
312 * Free a no longer needed unit number.
314 static __inline__ void
315 ng_iface_free_unit(int unit)
319 index = unit / UNITS_BITSPERWORD;
320 bit = unit % UNITS_BITSPERWORD;
321 KASSERT(index < ng_iface_units_len,
322 ("%s: unit=%d len=%d", __FUNCTION__, unit, ng_iface_units_len));
323 KASSERT((ng_iface_units[index] & (1 << bit)) == 0,
324 ("%s: unit=%d is free", __FUNCTION__, unit));
325 ng_iface_units[index] |= (1 << bit);
327 * XXX We could think about reducing the size of ng_iface_units[]
328 * XXX here if the last portion is all ones
332 /************************************************************************
334 ************************************************************************/
337 * Process an ioctl for the virtual interface
340 ng_iface_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
342 struct ifreq *const ifr = (struct ifreq *) data;
346 ng_iface_print_ioctl(ifp, command, data);
351 /* These two are mostly handled at a higher layer */
353 ifp->if_flags |= (IFF_UP | IFF_RUNNING);
354 ifp->if_flags &= ~(IFF_OACTIVE);
362 * If the interface is marked up and stopped, then start it.
363 * If it is marked down and running, then stop it.
365 if (ifr->ifr_flags & IFF_UP) {
366 if (!(ifp->if_flags & IFF_RUNNING)) {
367 ifp->if_flags &= ~(IFF_OACTIVE);
368 ifp->if_flags |= IFF_RUNNING;
371 if (ifp->if_flags & IFF_RUNNING)
372 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
376 /* Set the interface MTU */
378 if (ifr->ifr_mtu > NG_IFACE_MTU_MAX
379 || ifr->ifr_mtu < NG_IFACE_MTU_MIN)
382 ifp->if_mtu = ifr->ifr_mtu;
385 /* Stuff that's not supported */
403 * This routine is called to deliver a packet out the interface.
404 * We simply look at the address family and relay the packet to
405 * the corresponding hook, if it exists and is connected.
409 ng_iface_output(struct ifnet *ifp, struct mbuf *m,
410 struct sockaddr *dst, struct rtentry *rt0)
412 const priv_p priv = (priv_p) ifp->if_softc;
413 const iffam_p iffam = get_iffam_from_af(dst->sa_family);
417 /* Check interface flags */
418 if ((ifp->if_flags & (IFF_UP|IFF_RUNNING)) != (IFF_UP|IFF_RUNNING)) {
423 /* BPF writes need to be handled specially */
424 if (dst->sa_family == AF_UNSPEC) {
425 if (m->m_len < 4 && (m = m_pullup(m, 4)) == NULL)
427 dst->sa_family = (sa_family_t)*mtod(m, int32_t *);
430 m->m_pkthdr.len -= 4;
433 /* Berkeley packet filter */
434 ng_iface_bpftap(ifp, m, dst->sa_family);
436 /* Check address family to determine hook (if known) */
439 log(LOG_WARNING, "%s%d: can't handle af%d\n",
440 ifp->if_name, ifp->if_unit, (int)dst->sa_family);
441 return (EAFNOSUPPORT);
444 /* Copy length before the mbuf gets invalidated */
445 len = m->m_pkthdr.len;
447 /* Send packet; if hook is not connected, mbuf will get freed. */
448 NG_SEND_DATA(error, *get_hook_from_iffam(priv, iffam), m, meta);
452 ifp->if_obytes += len;
459 * This routine should never be called
463 ng_iface_start(struct ifnet *ifp)
465 printf("%s%d: %s called?", ifp->if_name, ifp->if_unit, __FUNCTION__);
469 * Flash a packet by the BPF (requires prepending 4 byte AF header)
470 * Note the phoney mbuf; this is OK because BPF treats it read-only.
473 ng_iface_bpftap(struct ifnet *ifp, struct mbuf *m, sa_family_t family)
475 int32_t family4 = (int32_t)family;
478 KASSERT(family != AF_UNSPEC, ("%s: family=AF_UNSPEC", __FUNCTION__));
479 if (ifp->if_bpf != NULL) {
480 bzero(&m0, sizeof(m0));
482 m0.m_len = sizeof(family4);
483 m0.m_data = (char *)&family4;
490 * Display an ioctl to the virtual interface
494 ng_iface_print_ioctl(struct ifnet *ifp, int command, caddr_t data)
498 switch (command & IOC_DIRMASK) {
514 log(LOG_DEBUG, "%s%d: %s('%c', %d, char[%d])\n",
515 ifp->if_name, ifp->if_unit,
519 IOCPARM_LEN(command));
523 /************************************************************************
525 ************************************************************************/
528 * Constructor for a node
531 ng_iface_constructor(node_p *nodep)
533 char ifname[NG_IFACE_IFACE_NAME_MAX + 1];
539 /* Allocate node and interface private structures */
540 MALLOC(priv, priv_p, sizeof(*priv), M_NETGRAPH, M_NOWAIT);
543 bzero(priv, sizeof(*priv));
544 MALLOC(ifp, struct ifnet *, sizeof(*ifp), M_NETGRAPH, M_NOWAIT);
546 FREE(priv, M_NETGRAPH);
549 bzero(ifp, sizeof(*ifp));
551 /* Link them together */
552 ifp->if_softc = priv;
555 /* Get an interface unit number */
556 if ((error = ng_iface_get_unit(&priv->unit)) != 0) {
557 FREE(ifp, M_NETGRAPH);
558 FREE(priv, M_NETGRAPH);
562 /* Call generic node constructor */
563 if ((error = ng_make_node_common(&typestruct, nodep)) != 0) {
564 ng_iface_free_unit(priv->unit);
565 FREE(ifp, M_NETGRAPH);
566 FREE(priv, M_NETGRAPH);
571 /* Link together node and private info */
572 node->private = priv;
575 /* Initialize interface structure */
576 ifp->if_name = NG_IFACE_IFACE_NAME;
577 ifp->if_unit = priv->unit;
578 ifp->if_output = ng_iface_output;
579 ifp->if_start = ng_iface_start;
580 ifp->if_ioctl = ng_iface_ioctl;
581 ifp->if_watchdog = NULL;
582 ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
583 ifp->if_mtu = NG_IFACE_MTU_DEFAULT;
584 ifp->if_flags = (IFF_SIMPLEX|IFF_POINTOPOINT|IFF_NOARP|IFF_MULTICAST);
585 ifp->if_type = IFT_PROPVIRTUAL; /* XXX */
586 ifp->if_addrlen = 0; /* XXX */
587 ifp->if_hdrlen = 0; /* XXX */
588 ifp->if_baudrate = 64000; /* XXX */
589 TAILQ_INIT(&ifp->if_addrhead);
591 /* Give this node the same name as the interface (if possible) */
592 bzero(ifname, sizeof(ifname));
593 snprintf(ifname, sizeof(ifname), "%s%d", ifp->if_name, ifp->if_unit);
594 if (ng_name_node(node, ifname) != 0)
595 log(LOG_WARNING, "%s: can't acquire netgraph name\n", ifname);
597 /* Attach the interface */
599 bpfattach(ifp, DLT_NULL, sizeof(u_int));
606 * Give our ok for a hook to be added
609 ng_iface_newhook(node_p node, hook_p hook, const char *name)
611 const iffam_p iffam = get_iffam_from_name(name);
615 return (EPFNOSUPPORT);
616 hookptr = get_hook_from_iffam((priv_p) node->private, iffam);
617 if (*hookptr != NULL)
624 * Receive a control message
627 ng_iface_rcvmsg(node_p node, struct ng_mesg *msg,
628 const char *retaddr, struct ng_mesg **rptr)
630 const priv_p priv = node->private;
631 struct ifnet *const ifp = priv->ifp;
632 struct ng_mesg *resp = NULL;
635 switch (msg->header.typecookie) {
636 case NGM_IFACE_COOKIE:
637 switch (msg->header.cmd) {
638 case NGM_IFACE_GET_IFNAME:
640 struct ng_iface_ifname *arg;
642 NG_MKRESPONSE(resp, msg, sizeof(*arg), M_NOWAIT);
647 arg = (struct ng_iface_ifname *)resp->data;
648 snprintf(arg->ngif_name, sizeof(arg->ngif_name),
649 "%s%d", ifp->if_name, ifp->if_unit);
653 case NGM_IFACE_POINT2POINT:
654 case NGM_IFACE_BROADCAST:
657 /* Deny request if interface is UP */
658 if ((ifp->if_flags & IFF_UP) != 0)
662 switch (msg->header.cmd) {
663 case NGM_IFACE_POINT2POINT:
664 ifp->if_flags |= IFF_POINTOPOINT;
665 ifp->if_flags &= ~IFF_BROADCAST;
667 case NGM_IFACE_BROADCAST:
668 ifp->if_flags &= ~IFF_POINTOPOINT;
669 ifp->if_flags |= IFF_BROADCAST;
680 case NGM_CISCO_COOKIE:
681 switch (msg->header.cmd) {
682 case NGM_CISCO_GET_IPADDR: /* we understand this too */
686 /* Return the first configured IP address */
687 TAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) {
688 struct ng_cisco_ipaddr *ips;
690 if (ifa->ifa_addr->sa_family != AF_INET)
692 NG_MKRESPONSE(resp, msg, sizeof(ips), M_NOWAIT);
697 ips = (struct ng_cisco_ipaddr *)resp->data;
698 ips->ipaddr = ((struct sockaddr_in *)
699 ifa->ifa_addr)->sin_addr;
700 ips->netmask = ((struct sockaddr_in *)
701 ifa->ifa_netmask)->sin_addr;
705 /* No IP addresses on this interface? */
707 error = EADDRNOTAVAIL;
722 FREE(resp, M_NETGRAPH);
723 FREE(msg, M_NETGRAPH);
728 * Recive data from a hook. Pass the packet to the correct input routine.
731 ng_iface_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
733 const priv_p priv = hook->node->private;
734 const iffam_p iffam = get_iffam_from_hook(priv, hook);
735 struct ifnet *const ifp = priv->ifp;
739 KASSERT(iffam != NULL, ("%s: iffam", __FUNCTION__));
740 KASSERT(m->m_flags & M_PKTHDR, ("%s: not pkthdr", __FUNCTION__));
743 if ((ifp->if_flags & IFF_UP) == 0) {
744 NG_FREE_DATA(m, meta);
748 /* Update interface stats */
750 ifp->if_ibytes += m->m_pkthdr.len;
752 /* Note receiving interface */
753 m->m_pkthdr.rcvif = ifp;
755 /* Berkeley packet filter */
756 ng_iface_bpftap(ifp, m, iffam->family);
758 /* Ignore any meta-data */
762 switch (iffam->family) {
785 return (EAFNOSUPPORT);
787 netisr_dispatch(isr, m);
792 * Shutdown and remove the node and its associated interface.
795 ng_iface_rmnode(node_p node)
797 const priv_p priv = node->private;
801 bpfdetach(priv->ifp);
802 if_detach(priv->ifp);
803 FREE(priv->ifp, M_NETGRAPH);
805 ng_iface_free_unit(priv->unit);
806 FREE(priv, M_NETGRAPH);
807 node->private = NULL;
813 * Hook disconnection. Note that we do *not* shutdown when all
814 * hooks have been disconnected.
817 ng_iface_disconnect(hook_p hook)
819 const priv_p priv = hook->node->private;
820 const iffam_p iffam = get_iffam_from_hook(priv, hook);
824 *get_hook_from_iffam(priv, iffam) = NULL;