sys/netgraph/eiface/ng_eiface.c

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