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