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.10 2005/02/17 13:59:59 joerg 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,
117 static int ng_iface_output(struct ifnet *ifp, struct mbuf *m0,
118 struct sockaddr *dst, struct rtentry *rt0);
119 static void ng_iface_bpftap(struct ifnet *ifp,
120 struct mbuf *m, sa_family_t family);
122 static void ng_iface_print_ioctl(struct ifnet *ifp, int cmd, caddr_t data);
125 /* Netgraph methods */
126 static ng_constructor_t ng_iface_constructor;
127 static ng_rcvmsg_t ng_iface_rcvmsg;
128 static ng_shutdown_t ng_iface_rmnode;
129 static ng_newhook_t ng_iface_newhook;
130 static ng_rcvdata_t ng_iface_rcvdata;
131 static ng_disconnect_t ng_iface_disconnect;
134 static iffam_p get_iffam_from_af(sa_family_t family);
135 static iffam_p get_iffam_from_hook(priv_p priv, hook_p hook);
136 static iffam_p get_iffam_from_name(const char *name);
137 static hook_p *get_hook_from_iffam(priv_p priv, iffam_p iffam);
139 /* Parse type for struct ng_iface_ifname */
140 static const struct ng_parse_fixedstring_info ng_iface_ifname_info = {
141 NG_IFACE_IFACE_NAME_MAX + 1
143 static const struct ng_parse_type ng_iface_ifname_type = {
144 &ng_parse_fixedstring_type,
145 &ng_iface_ifname_info
148 /* Parse type for struct ng_cisco_ipaddr */
149 static const struct ng_parse_struct_field ng_cisco_ipaddr_type_fields[]
150 = NG_CISCO_IPADDR_TYPE_INFO;
151 static const struct ng_parse_type ng_cisco_ipaddr_type = {
152 &ng_parse_struct_type,
153 &ng_cisco_ipaddr_type_fields
156 /* List of commands and how to convert arguments to/from ASCII */
157 static const struct ng_cmdlist ng_iface_cmds[] = {
160 NGM_IFACE_GET_IFNAME,
163 &ng_iface_ifname_type
167 NGM_IFACE_POINT2POINT,
181 NGM_CISCO_GET_IPADDR,
184 &ng_cisco_ipaddr_type
189 /* Node type descriptor */
190 static struct ng_type typestruct = {
194 ng_iface_constructor,
205 NETGRAPH_INIT(iface, &typestruct);
207 /* We keep a bitmap indicating which unit numbers are free.
208 One means the unit number is free, zero means it's taken. */
209 static int *ng_iface_units = NULL;
210 static int ng_iface_units_len = 0;
212 #define UNITS_BITSPERWORD (sizeof(*ng_iface_units) * NBBY)
214 /************************************************************************
216 ************************************************************************/
219 * Get the family descriptor from the family ID
221 static __inline__ iffam_p
222 get_iffam_from_af(sa_family_t family)
227 for (k = 0; k < NUM_FAMILIES; k++) {
228 iffam = &gFamilies[k];
229 if (iffam->family == family)
236 * Get the family descriptor from the hook
238 static __inline__ iffam_p
239 get_iffam_from_hook(priv_p priv, hook_p hook)
243 for (k = 0; k < NUM_FAMILIES; k++)
244 if (priv->hooks[k] == hook)
245 return (&gFamilies[k]);
250 * Get the hook from the iffam descriptor
253 static __inline__ hook_p *
254 get_hook_from_iffam(priv_p priv, iffam_p iffam)
256 return (&priv->hooks[iffam - gFamilies]);
260 * Get the iffam descriptor from the name
262 static __inline__ iffam_p
263 get_iffam_from_name(const char *name)
268 for (k = 0; k < NUM_FAMILIES; k++) {
269 iffam = &gFamilies[k];
270 if (!strcmp(iffam->hookname, name))
277 * Find the first free unit number for a new interface.
278 * Increase the size of the unit bitmap as necessary.
280 static __inline__ int
281 ng_iface_get_unit(int *unit)
285 for (index = 0; index < ng_iface_units_len
286 && ng_iface_units[index] == 0; index++);
287 if (index == ng_iface_units_len) { /* extend array */
288 int i, *newarray, newlen;
290 newlen = (2 * ng_iface_units_len) + 4;
291 MALLOC(newarray, int *, newlen * sizeof(*ng_iface_units),
292 M_NETGRAPH, M_NOWAIT);
293 if (newarray == NULL)
295 bcopy(ng_iface_units, newarray,
296 ng_iface_units_len * sizeof(*ng_iface_units));
297 for (i = ng_iface_units_len; i < newlen; i++)
299 if (ng_iface_units != NULL)
300 FREE(ng_iface_units, M_NETGRAPH);
301 ng_iface_units = newarray;
302 ng_iface_units_len = newlen;
304 bit = ffs(ng_iface_units[index]) - 1;
305 KASSERT(bit >= 0 && bit <= UNITS_BITSPERWORD - 1,
306 ("%s: word=%d bit=%d", __func__, ng_iface_units[index], bit));
307 ng_iface_units[index] &= ~(1 << bit);
308 *unit = (index * UNITS_BITSPERWORD) + bit;
313 * Free a no longer needed unit number.
315 static __inline__ void
316 ng_iface_free_unit(int unit)
320 index = unit / UNITS_BITSPERWORD;
321 bit = unit % UNITS_BITSPERWORD;
322 KASSERT(index < ng_iface_units_len,
323 ("%s: unit=%d len=%d", __func__, unit, ng_iface_units_len));
324 KASSERT((ng_iface_units[index] & (1 << bit)) == 0,
325 ("%s: unit=%d is free", __func__, unit));
326 ng_iface_units[index] |= (1 << bit);
328 * XXX We could think about reducing the size of ng_iface_units[]
329 * XXX here if the last portion is all ones
333 /************************************************************************
335 ************************************************************************/
338 * Process an ioctl for the virtual interface
341 ng_iface_ioctl(struct ifnet *ifp, u_long command, caddr_t data,
344 struct ifreq *const ifr = (struct ifreq *) data;
348 ng_iface_print_ioctl(ifp, command, data);
353 /* These two are mostly handled at a higher layer */
355 ifp->if_flags |= (IFF_UP | IFF_RUNNING);
356 ifp->if_flags &= ~(IFF_OACTIVE);
364 * If the interface is marked up and stopped, then start it.
365 * If it is marked down and running, then stop it.
367 if (ifr->ifr_flags & IFF_UP) {
368 if (!(ifp->if_flags & IFF_RUNNING)) {
369 ifp->if_flags &= ~(IFF_OACTIVE);
370 ifp->if_flags |= IFF_RUNNING;
373 if (ifp->if_flags & IFF_RUNNING)
374 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
378 /* Set the interface MTU */
380 if (ifr->ifr_mtu > NG_IFACE_MTU_MAX
381 || ifr->ifr_mtu < NG_IFACE_MTU_MIN)
384 ifp->if_mtu = ifr->ifr_mtu;
387 /* Stuff that's not supported */
405 * This routine is called to deliver a packet out the interface.
406 * We simply look at the address family and relay the packet to
407 * the corresponding hook, if it exists and is connected.
411 ng_iface_output(struct ifnet *ifp, struct mbuf *m,
412 struct sockaddr *dst, struct rtentry *rt0)
414 const priv_p priv = (priv_p) ifp->if_softc;
415 const iffam_p iffam = get_iffam_from_af(dst->sa_family);
419 /* Check interface flags */
420 if ((ifp->if_flags & (IFF_UP|IFF_RUNNING)) != (IFF_UP|IFF_RUNNING)) {
425 /* BPF writes need to be handled specially */
426 if (dst->sa_family == AF_UNSPEC) {
427 if (m->m_len < 4 && (m = m_pullup(m, 4)) == NULL)
429 dst->sa_family = (sa_family_t)*mtod(m, int32_t *);
432 m->m_pkthdr.len -= 4;
435 /* Berkeley packet filter */
436 ng_iface_bpftap(ifp, m, dst->sa_family);
438 /* Check address family to determine hook (if known) */
441 log(LOG_WARNING, "%s: can't handle af%d\n",
442 ifp->if_xname, (int)dst->sa_family);
443 return (EAFNOSUPPORT);
446 /* Copy length before the mbuf gets invalidated */
447 len = m->m_pkthdr.len;
449 /* Send packet; if hook is not connected, mbuf will get freed. */
450 NG_SEND_DATA(error, *get_hook_from_iffam(priv, iffam), m, meta);
454 ifp->if_obytes += len;
461 * This routine should never be called
465 ng_iface_start(struct ifnet *ifp)
467 printf("%s: %s called?", ifp->if_xname, __func__);
471 * Flash a packet by the BPF (requires prepending 4 byte AF header)
474 ng_iface_bpftap(struct ifnet *ifp, struct mbuf *m, sa_family_t family)
476 int32_t family4 = (int32_t)family;
478 KASSERT(family != AF_UNSPEC, ("%s: family=AF_UNSPEC", __func__));
481 bpf_ptap(ifp->if_bpf, m, &family, sizeof(family4));
486 * Display an ioctl to the virtual interface
490 ng_iface_print_ioctl(struct ifnet *ifp, int command, caddr_t data)
494 switch (command & IOC_DIRMASK) {
510 log(LOG_DEBUG, "%s: %s('%c', %d, char[%d])\n",
515 IOCPARM_LEN(command));
519 /************************************************************************
521 ************************************************************************/
524 * Constructor for a node
527 ng_iface_constructor(node_p *nodep)
529 char ifname[NG_IFACE_IFACE_NAME_MAX + 1];
535 /* Allocate node and interface private structures */
536 MALLOC(priv, priv_p, sizeof(*priv), M_NETGRAPH, M_NOWAIT);
539 bzero(priv, sizeof(*priv));
540 MALLOC(ifp, struct ifnet *, sizeof(*ifp), M_NETGRAPH, M_NOWAIT);
542 FREE(priv, M_NETGRAPH);
545 bzero(ifp, sizeof(*ifp));
547 /* Link them together */
548 ifp->if_softc = priv;
551 /* Get an interface unit number */
552 if ((error = ng_iface_get_unit(&priv->unit)) != 0) {
553 FREE(ifp, M_NETGRAPH);
554 FREE(priv, M_NETGRAPH);
558 /* Call generic node constructor */
559 if ((error = ng_make_node_common(&typestruct, nodep)) != 0) {
560 ng_iface_free_unit(priv->unit);
561 FREE(ifp, M_NETGRAPH);
562 FREE(priv, M_NETGRAPH);
567 /* Link together node and private info */
568 node->private = priv;
571 /* Initialize interface structure */
572 if_initname(ifp, NG_IFACE_IFACE_NAME, priv->unit);
573 ifp->if_output = ng_iface_output;
574 ifp->if_start = ng_iface_start;
575 ifp->if_ioctl = ng_iface_ioctl;
576 ifp->if_watchdog = NULL;
577 ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
578 ifp->if_mtu = NG_IFACE_MTU_DEFAULT;
579 ifp->if_flags = (IFF_SIMPLEX|IFF_POINTOPOINT|IFF_NOARP|IFF_MULTICAST);
580 ifp->if_type = IFT_PROPVIRTUAL; /* XXX */
581 ifp->if_addrlen = 0; /* XXX */
582 ifp->if_hdrlen = 0; /* XXX */
583 ifp->if_baudrate = 64000; /* XXX */
584 TAILQ_INIT(&ifp->if_addrhead);
586 /* Give this node the same name as the interface (if possible) */
587 bzero(ifname, sizeof(ifname));
588 strlcpy(ifname, ifp->if_xname, sizeof(ifname));
589 if (ng_name_node(node, ifname) != 0)
590 log(LOG_WARNING, "%s: can't acquire netgraph name\n", ifname);
592 /* Attach the interface */
594 bpfattach(ifp, DLT_NULL, sizeof(u_int));
601 * Give our ok for a hook to be added
604 ng_iface_newhook(node_p node, hook_p hook, const char *name)
606 const iffam_p iffam = get_iffam_from_name(name);
610 return (EPFNOSUPPORT);
611 hookptr = get_hook_from_iffam((priv_p) node->private, iffam);
612 if (*hookptr != NULL)
619 * Receive a control message
622 ng_iface_rcvmsg(node_p node, struct ng_mesg *msg,
623 const char *retaddr, struct ng_mesg **rptr)
625 const priv_p priv = node->private;
626 struct ifnet *const ifp = priv->ifp;
627 struct ng_mesg *resp = NULL;
630 switch (msg->header.typecookie) {
631 case NGM_IFACE_COOKIE:
632 switch (msg->header.cmd) {
633 case NGM_IFACE_GET_IFNAME:
635 struct ng_iface_ifname *arg;
637 NG_MKRESPONSE(resp, msg, sizeof(*arg), M_NOWAIT);
642 arg = (struct ng_iface_ifname *)resp->data;
643 strlcpy(arg->ngif_name, ifp->if_xname,
644 sizeof(arg->ngif_name));
648 case NGM_IFACE_POINT2POINT:
649 case NGM_IFACE_BROADCAST:
652 /* Deny request if interface is UP */
653 if ((ifp->if_flags & IFF_UP) != 0)
657 switch (msg->header.cmd) {
658 case NGM_IFACE_POINT2POINT:
659 ifp->if_flags |= IFF_POINTOPOINT;
660 ifp->if_flags &= ~IFF_BROADCAST;
662 case NGM_IFACE_BROADCAST:
663 ifp->if_flags &= ~IFF_POINTOPOINT;
664 ifp->if_flags |= IFF_BROADCAST;
675 case NGM_CISCO_COOKIE:
676 switch (msg->header.cmd) {
677 case NGM_CISCO_GET_IPADDR: /* we understand this too */
681 /* Return the first configured IP address */
682 TAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) {
683 struct ng_cisco_ipaddr *ips;
685 if (ifa->ifa_addr->sa_family != AF_INET)
687 NG_MKRESPONSE(resp, msg, sizeof(ips), M_NOWAIT);
692 ips = (struct ng_cisco_ipaddr *)resp->data;
693 ips->ipaddr = ((struct sockaddr_in *)
694 ifa->ifa_addr)->sin_addr;
695 ips->netmask = ((struct sockaddr_in *)
696 ifa->ifa_netmask)->sin_addr;
700 /* No IP addresses on this interface? */
702 error = EADDRNOTAVAIL;
717 FREE(resp, M_NETGRAPH);
718 FREE(msg, M_NETGRAPH);
723 * Recive data from a hook. Pass the packet to the correct input routine.
726 ng_iface_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
728 const priv_p priv = hook->node->private;
729 const iffam_p iffam = get_iffam_from_hook(priv, hook);
730 struct ifnet *const ifp = priv->ifp;
734 KASSERT(iffam != NULL, ("%s: iffam", __func__));
735 KASSERT(m->m_flags & M_PKTHDR, ("%s: not pkthdr", __func__));
738 if ((ifp->if_flags & IFF_UP) == 0) {
739 NG_FREE_DATA(m, meta);
743 /* Update interface stats */
745 ifp->if_ibytes += m->m_pkthdr.len;
747 /* Note receiving interface */
748 m->m_pkthdr.rcvif = ifp;
750 /* Berkeley packet filter */
751 ng_iface_bpftap(ifp, m, iffam->family);
753 /* Ignore any meta-data */
757 switch (iffam->family) {
780 return (EAFNOSUPPORT);
782 netisr_dispatch(isr, m);
787 * Shutdown and remove the node and its associated interface.
790 ng_iface_rmnode(node_p node)
792 const priv_p priv = node->private;
796 bpfdetach(priv->ifp);
797 if_detach(priv->ifp);
798 FREE(priv->ifp, M_NETGRAPH);
800 ng_iface_free_unit(priv->unit);
801 FREE(priv, M_NETGRAPH);
802 node->private = NULL;
808 * Hook disconnection. Note that we do *not* shutdown when all
809 * hooks have been disconnected.
812 ng_iface_disconnect(hook_p hook)
814 const priv_p priv = hook->node->private;
815 const iffam_p iffam = get_iffam_from_hook(priv, hook);
819 *get_hook_from_iffam(priv, iffam) = NULL;