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.16 2008/01/06 16:55:52 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
 321         ifp = &(priv->arpcom.ac_if);
 322
 323         /* Link them together */
 324         ifp->if_softc = priv;
 325         priv->ifp = ifp;
 326
 327         /* Call generic node constructor */
 328         if ((error = ng_make_node_common(&typestruct, nodep))) {
 329                 FREE(priv, M_NETGRAPH);
 330                 return (error);
 331         }
 332         node = *nodep;
 333
 334         /* Link together node and private info */
 335         node->private = priv;
 336         priv->node = node;
 337
 338         /* Initialize interface structure */
 339         if_initname(ifp, ng_eiface_ifname, ng_eiface_next_unit++);
 340         ifp->if_init = ng_eiface_init;
 341         ifp->if_start = ng_eiface_start;
 342         ifp->if_ioctl = ng_eiface_ioctl;
 343         ifp->if_watchdog = NULL;
 344         ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
 345         ifp->if_flags = (IFF_SIMPLEX | IFF_BROADCAST | IFF_MULTICAST);
 346
 347         TAILQ_INIT(&ifp->if_addrhead);
 348
 349         /* Give this node name *
 350         bzero(ifname, sizeof(ifname));
 351         ksprintf(ifname, "if%s", ifp->if_xname);
 352         ng_name_node(node, ifname);
 353         */
 354
 355         /* Attach the interface */
 356         ether_ifattach(ifp, priv->arpcom.ac_enaddr, NULL);
 357
 358         /* Done */
 359         return (0);
 360 }
 361
 362 /*
 363  * Give our ok for a hook to be added
 364  */
 365 static int
 366 ng_eiface_newhook(node_p node, hook_p hook, const char *name)
 367 {
 368         priv_p priv = node->private;
 369
 370         if (strcmp(name, NG_EIFACE_HOOK_ETHER))
 371                 return (EPFNOSUPPORT);
 372         if (priv->ether != NULL)
 373                 return (EISCONN);
 374         priv->ether = hook;
 375         hook->private = &priv->ether;
 376
 377         return (0);
 378 }
 379
 380 /*
 381  * Receive a control message
 382  */
 383 static int
 384 ng_eiface_rcvmsg(node_p node, struct ng_mesg *msg,
 385                 const char *retaddr, struct ng_mesg **rptr)
 386 {
 387         const priv_p priv = node->private;
 388         struct ifnet *const ifp = priv->ifp;
 389         struct ng_mesg *resp = NULL;
 390         int error = 0;
 391
 392         switch (msg->header.typecookie) {
 393         case NGM_EIFACE_COOKIE:
 394                 switch (msg->header.cmd) {
 395
 396                 case NGM_EIFACE_SET:
 397                     {
 398                       struct ng_eiface_par *eaddr;
 399
 400                       if (msg->header.arglen != sizeof(struct ng_eiface_par))
 401                         {
 402                           error = EINVAL;
 403                           break;
 404                         }
 405                       eaddr = (struct ng_eiface_par *)(msg->data);
 406
 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;
 413
 414                       break;
 415                     }
 416
 417                 case NGM_EIFACE_GET_IFNAME:
 418                     {
 419                         struct ng_eiface_ifname *arg;
 420
 421                         NG_MKRESPONSE(resp, msg, sizeof(*arg), M_NOWAIT);
 422                         if (resp == NULL) {
 423                                 error = ENOMEM;
 424                                 break;
 425                         }
 426                         arg = (struct ng_eiface_ifname *) resp->data;
 427                         ksprintf(arg->ngif_name,
 428                             "%s", ifp->if_xname); /* XXX: strings */
 429                         break;
 430                     }
 431
 432                 case NGM_EIFACE_GET_IFADDRS:
 433                     {
 434                         struct ifaddr *ifa;
 435                         caddr_t ptr;
 436                         int buflen;
 437
 438 #define SA_SIZE(s)      ((s)->sa_len<sizeof(*(s))? sizeof(*(s)):(s)->sa_len)
 439
 440                         /* Determine size of response and allocate it */
 441                         buflen = 0;
 442                         TAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link)
 443                                 buflen += SA_SIZE(ifa->ifa_addr);
 444                         NG_MKRESPONSE(resp, msg, buflen, M_NOWAIT);
 445                         if (resp == NULL) {
 446                                 error = ENOMEM;
 447                                 break;
 448                         }
 449
 450                         /* Add addresses */
 451                         ptr = resp->data;
 452                         TAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) {
 453                                 const int len = SA_SIZE(ifa->ifa_addr);
 454
 455                                 if (buflen < len) {
 456                                         log(LOG_ERR, "%s: len changed?\n",
 457                                             ifp->if_xname);
 458                                         break;
 459                                 }
 460                                 bcopy(ifa->ifa_addr, ptr, len);
 461                                 ptr += len;
 462                                 buflen -= len;
 463                         }
 464                         break;
 465 #undef SA_SIZE
 466                     }
 467
 468                 default:
 469                         error = EINVAL;
 470                         break;
 471                 }
 472                 break;
 473         default:
 474                 error = EINVAL;
 475                 break;
 476         }
 477         if (rptr)
 478                 *rptr = resp;
 479         else if (resp)
 480                 FREE(resp, M_NETGRAPH);
 481         FREE(msg, M_NETGRAPH);
 482         return (error);
 483 }
 484
 485 /*
 486  * Recive data from a hook. Pass the packet to the ether_input routine.
 487  */
 488 static int
 489 ng_eiface_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
 490 {
 491         const priv_p priv = hook->node->private;
 492         struct ifnet *const ifp = priv->ifp;
 493         int error = 0;
 494
 495         /* Meta-data is end its life here... */
 496         NG_FREE_META(meta);
 497
 498         if (m == NULL)
 499           {
 500             kprintf("ng_eiface: mbuf is null.\n");
 501             return (EINVAL);
 502           }
 503
 504         lwkt_serialize_enter(ifp->if_serializer);
 505         if ( !(ifp->if_flags & IFF_UP) ) {
 506                 lwkt_serialize_exit(ifp->if_serializer);
 507                 return (ENETDOWN);
 508         }
 509
 510         /* Note receiving interface */
 511         m->m_pkthdr.rcvif = ifp;
 512
 513         /* Update interface stats */
 514         ifp->if_ipackets++;
 515
 516         BPF_MTAP(ifp, m);
 517
 518         ifp->if_input(ifp, m);
 519         lwkt_serialize_exit(ifp->if_serializer);
 520
 521         /* Done */
 522         return (error);
 523 }
 524
 525 /*
 526  * Because the BSD networking code doesn't support the removal of
 527  * networking interfaces, iface nodes (once created) are persistent.
 528  * So this method breaks all connections and marks the interface
 529  * down, but does not remove the node.
 530  */
 531 static int
 532 ng_eiface_rmnode(node_p node)
 533 {
 534         const priv_p priv = node->private;
 535         struct ifnet *const ifp = priv->ifp;
 536
 537         ng_cutlinks(node);
 538         node->flags &= ~NG_INVALID;
 539         lwkt_serialize_enter(ifp->if_serializer);
 540         ifp->if_flags &= ~(IFF_UP | IFF_RUNNING | IFF_OACTIVE);
 541         lwkt_serialize_exit(ifp->if_serializer);
 542         return (0);
 543 }
 544
 545
 546 /*
 547  * This is called once we've already connected a new hook to the other node.
 548  * It gives us a chance to balk at the last minute.
 549  */
 550 static int
 551 ng_eiface_connect(hook_p hook)
 552 {
 553         /* be really amiable and just say "YUP that's OK by me! " */
 554         return (0);
 555 }
 556
 557 /*
 558  * Hook disconnection
 559  */
 560 static int
 561 ng_eiface_disconnect(hook_p hook)
 562 {
 563         const priv_p priv = hook->node->private;
 564
 565         priv->ether = NULL;
 566         return (0);
 567 }