sys/net/if_tap.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (C) 1999-2000 by Maksim Yevmenkin <m_evmenkin@yahoo.com>
   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, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * BASED ON:
  29  * -------------------------------------------------------------------------
  30  *
  31  * Copyright (c) 1988, Julian Onions <jpo@cs.nott.ac.uk>
  32  * Nottingham University 1987.
  33  */
  34
  35 /*
  36  * $FreeBSD$
  37  * $Id: if_tap.c,v 0.21 2000/07/23 21:46:02 max Exp $
  38  */
  39
  40 #include "opt_compat.h"
  41 #include "opt_inet.h"
  42
  43 #include <sys/param.h>
  44 #include <sys/conf.h>
  45 #include <sys/fcntl.h>
  46 #include <sys/filio.h>
  47 #include <sys/jail.h>
  48 #include <sys/kernel.h>
  49 #include <sys/malloc.h>
  50 #include <sys/mbuf.h>
  51 #include <sys/module.h>
  52 #include <sys/poll.h>
  53 #include <sys/priv.h>
  54 #include <sys/proc.h>
  55 #include <sys/selinfo.h>
  56 #include <sys/signalvar.h>
  57 #include <sys/socket.h>
  58 #include <sys/sockio.h>
  59 #include <sys/sysctl.h>
  60 #include <sys/systm.h>
  61 #include <sys/ttycom.h>
  62 #include <sys/uio.h>
  63 #include <sys/queue.h>
  64
  65 #include <net/bpf.h>
  66 #include <net/ethernet.h>
  67 #include <net/if.h>
  68 #include <net/if_var.h>
  69 #include <net/if_clone.h>
  70 #include <net/if_dl.h>
  71 #include <net/if_media.h>
  72 #include <net/if_types.h>
  73 #include <net/route.h>
  74 #include <net/vnet.h>
  75
  76 #include <netinet/in.h>
  77
  78 #include <net/if_tapvar.h>
  79 #include <net/if_tap.h>
  80
  81
  82 #define CDEV_NAME       "tap"
  83 #define TAPDEBUG        if (tapdebug) printf
  84
  85 static const char tapname[] = "tap";
  86 static const char vmnetname[] = "vmnet";
  87 #define TAPMAXUNIT      0x7fff
  88 #define VMNET_DEV_MASK  CLONE_FLAG0
  89
  90 /* module */
  91 static int              tapmodevent(module_t, int, void *);
  92
  93 /* device */
  94 static void             tapclone(void *, struct ucred *, char *, int,
  95                             struct cdev **);
  96 static void             tapcreate(struct cdev *);
  97
  98 /* network interface */
  99 static void             tapifstart(struct ifnet *);
 100 static int              tapifioctl(struct ifnet *, u_long, caddr_t);
 101 static void             tapifinit(void *);
 102
 103 static int              tap_clone_create(struct if_clone *, int, caddr_t);
 104 static void             tap_clone_destroy(struct ifnet *);
 105 static struct if_clone *tap_cloner;
 106 static int              vmnet_clone_create(struct if_clone *, int, caddr_t);
 107 static void             vmnet_clone_destroy(struct ifnet *);
 108 static struct if_clone *vmnet_cloner;
 109
 110 /* character device */
 111 static d_open_t         tapopen;
 112 static d_close_t        tapclose;
 113 static d_read_t         tapread;
 114 static d_write_t        tapwrite;
 115 static d_ioctl_t        tapioctl;
 116 static d_poll_t         tappoll;
 117 static d_kqfilter_t     tapkqfilter;
 118
 119 /* kqueue(2) */
 120 static int              tapkqread(struct knote *, long);
 121 static int              tapkqwrite(struct knote *, long);
 122 static void             tapkqdetach(struct knote *);
 123
 124 static struct filterops tap_read_filterops = {
 125         .f_isfd =       1,
 126         .f_attach =     NULL,
 127         .f_detach =     tapkqdetach,
 128         .f_event =      tapkqread,
 129 };
 130
 131 static struct filterops tap_write_filterops = {
 132         .f_isfd =       1,
 133         .f_attach =     NULL,
 134         .f_detach =     tapkqdetach,
 135         .f_event =      tapkqwrite,
 136 };
 137
 138 static struct cdevsw    tap_cdevsw = {
 139         .d_version =    D_VERSION,
 140         .d_flags =      D_NEEDMINOR,
 141         .d_open =       tapopen,
 142         .d_close =      tapclose,
 143         .d_read =       tapread,
 144         .d_write =      tapwrite,
 145         .d_ioctl =      tapioctl,
 146         .d_poll =       tappoll,
 147         .d_name =       CDEV_NAME,
 148         .d_kqfilter =   tapkqfilter,
 149 };
 150
 151 /*
 152  * All global variables in if_tap.c are locked with tapmtx, with the
 153  * exception of tapdebug, which is accessed unlocked; tapclones is
 154  * static at runtime.
 155  */
 156 static struct mtx               tapmtx;
 157 static int                      tapdebug = 0;        /* debug flag   */
 158 static int                      tapuopen = 0;        /* allow user open() */
 159 static int                      tapuponopen = 0;    /* IFF_UP on open() */
 160 static int                      tapdclone = 1;  /* enable devfs cloning */
 161 static SLIST_HEAD(, tap_softc)  taphead;             /* first device */
 162 static struct clonedevs         *tapclones;
 163
 164 MALLOC_DECLARE(M_TAP);
 165 MALLOC_DEFINE(M_TAP, CDEV_NAME, "Ethernet tunnel interface");
 166 SYSCTL_INT(_debug, OID_AUTO, if_tap_debug, CTLFLAG_RW, &tapdebug, 0, "");
 167
 168 SYSCTL_DECL(_net_link);
 169 static SYSCTL_NODE(_net_link, OID_AUTO, tap, CTLFLAG_RW, 0,
 170     "Ethernet tunnel software network interface");
 171 SYSCTL_INT(_net_link_tap, OID_AUTO, user_open, CTLFLAG_RW, &tapuopen, 0,
 172         "Allow user to open /dev/tap (based on node permissions)");
 173 SYSCTL_INT(_net_link_tap, OID_AUTO, up_on_open, CTLFLAG_RW, &tapuponopen, 0,
 174         "Bring interface up when /dev/tap is opened");
 175 SYSCTL_INT(_net_link_tap, OID_AUTO, devfs_cloning, CTLFLAG_RWTUN, &tapdclone, 0,
 176         "Enable legacy devfs interface creation");
 177 SYSCTL_INT(_net_link_tap, OID_AUTO, debug, CTLFLAG_RW, &tapdebug, 0, "");
 178
 179 DEV_MODULE(if_tap, tapmodevent, NULL);
 180
 181 static int
 182 tap_clone_create(struct if_clone *ifc, int unit, caddr_t params)
 183 {
 184         struct cdev *dev;
 185         int i;
 186
 187         /* Find any existing device, or allocate new unit number. */
 188         i = clone_create(&tapclones, &tap_cdevsw, &unit, &dev, 0);
 189         if (i) {
 190                 dev = make_dev(&tap_cdevsw, unit, UID_ROOT, GID_WHEEL, 0600,
 191                     "%s%d", tapname, unit);
 192         }
 193
 194         tapcreate(dev);
 195         return (0);
 196 }
 197
 198 /* vmnet devices are tap devices in disguise */
 199 static int
 200 vmnet_clone_create(struct if_clone *ifc, int unit, caddr_t params)
 201 {
 202         struct cdev *dev;
 203         int i;
 204
 205         /* Find any existing device, or allocate new unit number. */
 206         i = clone_create(&tapclones, &tap_cdevsw, &unit, &dev, VMNET_DEV_MASK);
 207         if (i) {
 208                 dev = make_dev(&tap_cdevsw, unit | VMNET_DEV_MASK, UID_ROOT,
 209                     GID_WHEEL, 0600, "%s%d", vmnetname, unit);
 210         }
 211
 212         tapcreate(dev);
 213         return (0);
 214 }
 215
 216 static void
 217 tap_destroy(struct tap_softc *tp)
 218 {
 219         struct ifnet *ifp = tp->tap_ifp;
 220
 221         CURVNET_SET(ifp->if_vnet);
 222         destroy_dev(tp->tap_dev);
 223         seldrain(&tp->tap_rsel);
 224         knlist_clear(&tp->tap_rsel.si_note, 0);
 225         knlist_destroy(&tp->tap_rsel.si_note);
 226         ether_ifdetach(ifp);
 227         if_free(ifp);
 228
 229         mtx_destroy(&tp->tap_mtx);
 230         free(tp, M_TAP);
 231         CURVNET_RESTORE();
 232 }
 233
 234 static void
 235 tap_clone_destroy(struct ifnet *ifp)
 236 {
 237         struct tap_softc *tp = ifp->if_softc;
 238
 239         mtx_lock(&tapmtx);
 240         SLIST_REMOVE(&taphead, tp, tap_softc, tap_next);
 241         mtx_unlock(&tapmtx);
 242         tap_destroy(tp);
 243 }
 244
 245 /* vmnet devices are tap devices in disguise */
 246 static void
 247 vmnet_clone_destroy(struct ifnet *ifp)
 248 {
 249         tap_clone_destroy(ifp);
 250 }
 251
 252 /*
 253  * tapmodevent
 254  *
 255  * module event handler
 256  */
 257 static int
 258 tapmodevent(module_t mod, int type, void *data)
 259 {
 260         static eventhandler_tag  eh_tag = NULL;
 261         struct tap_softc        *tp = NULL;
 262         struct ifnet            *ifp = NULL;
 263
 264         switch (type) {
 265         case MOD_LOAD:
 266
 267                 /* intitialize device */
 268
 269                 mtx_init(&tapmtx, "tapmtx", NULL, MTX_DEF);
 270                 SLIST_INIT(&taphead);
 271
 272                 clone_setup(&tapclones);
 273                 eh_tag = EVENTHANDLER_REGISTER(dev_clone, tapclone, 0, 1000);
 274                 if (eh_tag == NULL) {
 275                         clone_cleanup(&tapclones);
 276                         mtx_destroy(&tapmtx);
 277                         return (ENOMEM);
 278                 }
 279                 tap_cloner = if_clone_simple(tapname, tap_clone_create,
 280                     tap_clone_destroy, 0);
 281                 vmnet_cloner = if_clone_simple(vmnetname, vmnet_clone_create,
 282                     vmnet_clone_destroy, 0);
 283                 return (0);
 284
 285         case MOD_UNLOAD:
 286                 /*
 287                  * The EBUSY algorithm here can't quite atomically
 288                  * guarantee that this is race-free since we have to
 289                  * release the tap mtx to deregister the clone handler.
 290                  */
 291                 mtx_lock(&tapmtx);
 292                 SLIST_FOREACH(tp, &taphead, tap_next) {
 293                         mtx_lock(&tp->tap_mtx);
 294                         if (tp->tap_flags & TAP_OPEN) {
 295                                 mtx_unlock(&tp->tap_mtx);
 296                                 mtx_unlock(&tapmtx);
 297                                 return (EBUSY);
 298                         }
 299                         mtx_unlock(&tp->tap_mtx);
 300                 }
 301                 mtx_unlock(&tapmtx);
 302
 303                 EVENTHANDLER_DEREGISTER(dev_clone, eh_tag);
 304                 if_clone_detach(tap_cloner);
 305                 if_clone_detach(vmnet_cloner);
 306                 drain_dev_clone_events();
 307
 308                 mtx_lock(&tapmtx);
 309                 while ((tp = SLIST_FIRST(&taphead)) != NULL) {
 310                         SLIST_REMOVE_HEAD(&taphead, tap_next);
 311                         mtx_unlock(&tapmtx);
 312
 313                         ifp = tp->tap_ifp;
 314
 315                         TAPDEBUG("detaching %s\n", ifp->if_xname);
 316
 317                         tap_destroy(tp);
 318                         mtx_lock(&tapmtx);
 319                 }
 320                 mtx_unlock(&tapmtx);
 321                 clone_cleanup(&tapclones);
 322
 323                 mtx_destroy(&tapmtx);
 324
 325                 break;
 326
 327         default:
 328                 return (EOPNOTSUPP);
 329         }
 330
 331         return (0);
 332 } /* tapmodevent */
 333
 334
 335 /*
 336  * DEVFS handler
 337  *
 338  * We need to support two kind of devices - tap and vmnet
 339  */
 340 static void
 341 tapclone(void *arg, struct ucred *cred, char *name, int namelen, struct cdev **dev)
 342 {
 343         char            devname[SPECNAMELEN + 1];
 344         int             i, unit, append_unit;
 345         int             extra;
 346
 347         if (*dev != NULL)
 348                 return;
 349
 350         if (!tapdclone ||
 351             (!tapuopen && priv_check_cred(cred, PRIV_NET_IFCREATE, 0) != 0))
 352                 return;
 353
 354         unit = 0;
 355         append_unit = 0;
 356         extra = 0;
 357
 358         /* We're interested in only tap/vmnet devices. */
 359         if (strcmp(name, tapname) == 0) {
 360                 unit = -1;
 361         } else if (strcmp(name, vmnetname) == 0) {
 362                 unit = -1;
 363                 extra = VMNET_DEV_MASK;
 364         } else if (dev_stdclone(name, NULL, tapname, &unit) != 1) {
 365                 if (dev_stdclone(name, NULL, vmnetname, &unit) != 1) {
 366                         return;
 367                 } else {
 368                         extra = VMNET_DEV_MASK;
 369                 }
 370         }
 371
 372         if (unit == -1)
 373                 append_unit = 1;
 374
 375         CURVNET_SET(CRED_TO_VNET(cred));
 376         /* find any existing device, or allocate new unit number */
 377         i = clone_create(&tapclones, &tap_cdevsw, &unit, dev, extra);
 378         if (i) {
 379                 if (append_unit) {
 380                         /*
 381                          * We were passed 'tun' or 'tap', with no unit specified
 382                          * so we'll need to append it now.
 383                          */
 384                         namelen = snprintf(devname, sizeof(devname), "%s%d", name,
 385                             unit);
 386                         name = devname;
 387                 }
 388
 389                 *dev = make_dev_credf(MAKEDEV_REF, &tap_cdevsw, unit | extra,
 390                      cred, UID_ROOT, GID_WHEEL, 0600, "%s", name);
 391         }
 392
 393         if_clone_create(name, namelen, NULL);
 394         CURVNET_RESTORE();
 395 } /* tapclone */
 396
 397
 398 /*
 399  * tapcreate
 400  *
 401  * to create interface
 402  */
 403 static void
 404 tapcreate(struct cdev *dev)
 405 {
 406         struct ifnet            *ifp = NULL;
 407         struct tap_softc        *tp = NULL;
 408         unsigned short           macaddr_hi;
 409         uint32_t                 macaddr_mid;
 410         int                      unit;
 411         const char              *name = NULL;
 412         u_char                  eaddr[6];
 413
 414         /* allocate driver storage and create device */
 415         tp = malloc(sizeof(*tp), M_TAP, M_WAITOK | M_ZERO);
 416         mtx_init(&tp->tap_mtx, "tap_mtx", NULL, MTX_DEF);
 417         mtx_lock(&tapmtx);
 418         SLIST_INSERT_HEAD(&taphead, tp, tap_next);
 419         mtx_unlock(&tapmtx);
 420
 421         unit = dev2unit(dev);
 422
 423         /* select device: tap or vmnet */
 424         if (unit & VMNET_DEV_MASK) {
 425                 name = vmnetname;
 426                 tp->tap_flags |= TAP_VMNET;
 427         } else
 428                 name = tapname;
 429
 430         unit &= TAPMAXUNIT;
 431
 432         TAPDEBUG("tapcreate(%s%d). minor = %#x\n", name, unit, dev2unit(dev));
 433
 434         /* generate fake MAC address: 00 bd xx xx xx unit_no */
 435         macaddr_hi = htons(0x00bd);
 436         macaddr_mid = (uint32_t) ticks;
 437         bcopy(&macaddr_hi, eaddr, sizeof(short));
 438         bcopy(&macaddr_mid, &eaddr[2], sizeof(uint32_t));
 439         eaddr[5] = (u_char)unit;
 440
 441         /* fill the rest and attach interface */
 442         ifp = tp->tap_ifp = if_alloc(IFT_ETHER);
 443         if (ifp == NULL)
 444                 panic("%s%d: can not if_alloc()", name, unit);
 445         ifp->if_softc = tp;
 446         if_initname(ifp, name, unit);
 447         ifp->if_init = tapifinit;
 448         ifp->if_start = tapifstart;
 449         ifp->if_ioctl = tapifioctl;
 450         ifp->if_mtu = ETHERMTU;
 451         ifp->if_flags = (IFF_BROADCAST|IFF_SIMPLEX|IFF_MULTICAST);
 452         IFQ_SET_MAXLEN(&ifp->if_snd, ifqmaxlen);
 453         ifp->if_capabilities |= IFCAP_LINKSTATE;
 454         ifp->if_capenable |= IFCAP_LINKSTATE;
 455
 456         dev->si_drv1 = tp;
 457         tp->tap_dev = dev;
 458
 459         ether_ifattach(ifp, eaddr);
 460
 461         mtx_lock(&tp->tap_mtx);
 462         tp->tap_flags |= TAP_INITED;
 463         mtx_unlock(&tp->tap_mtx);
 464
 465         knlist_init_mtx(&tp->tap_rsel.si_note, &tp->tap_mtx);
 466
 467         TAPDEBUG("interface %s is created. minor = %#x\n",
 468                 ifp->if_xname, dev2unit(dev));
 469 } /* tapcreate */
 470
 471
 472 /*
 473  * tapopen
 474  *
 475  * to open tunnel. must be superuser
 476  */
 477 static int
 478 tapopen(struct cdev *dev, int flag, int mode, struct thread *td)
 479 {
 480         struct tap_softc        *tp = NULL;
 481         struct ifnet            *ifp = NULL;
 482         int                      error;
 483
 484         if (tapuopen == 0) {
 485                 error = priv_check(td, PRIV_NET_TAP);
 486                 if (error)
 487                         return (error);
 488         }
 489
 490         if ((dev2unit(dev) & CLONE_UNITMASK) > TAPMAXUNIT)
 491                 return (ENXIO);
 492
 493         tp = dev->si_drv1;
 494
 495         mtx_lock(&tp->tap_mtx);
 496         if (tp->tap_flags & TAP_OPEN) {
 497                 mtx_unlock(&tp->tap_mtx);
 498                 return (EBUSY);
 499         }
 500
 501         bcopy(IF_LLADDR(tp->tap_ifp), tp->ether_addr, sizeof(tp->ether_addr));
 502         tp->tap_pid = td->td_proc->p_pid;
 503         tp->tap_flags |= TAP_OPEN;
 504         ifp = tp->tap_ifp;
 505
 506         ifp->if_drv_flags |= IFF_DRV_RUNNING;
 507         ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
 508         if (tapuponopen)
 509                 ifp->if_flags |= IFF_UP;
 510         if_link_state_change(ifp, LINK_STATE_UP);
 511         mtx_unlock(&tp->tap_mtx);
 512
 513         TAPDEBUG("%s is open. minor = %#x\n", ifp->if_xname, dev2unit(dev));
 514
 515         return (0);
 516 } /* tapopen */
 517
 518
 519 /*
 520  * tapclose
 521  *
 522  * close the device - mark i/f down & delete routing info
 523  */
 524 static int
 525 tapclose(struct cdev *dev, int foo, int bar, struct thread *td)
 526 {
 527         struct ifaddr           *ifa;
 528         struct tap_softc        *tp = dev->si_drv1;
 529         struct ifnet            *ifp = tp->tap_ifp;
 530
 531         /* junk all pending output */
 532         mtx_lock(&tp->tap_mtx);
 533         CURVNET_SET(ifp->if_vnet);
 534         IF_DRAIN(&ifp->if_snd);
 535
 536         /*
 537          * Do not bring the interface down, and do not anything with
 538          * interface, if we are in VMnet mode. Just close the device.
 539          */
 540         if (((tp->tap_flags & TAP_VMNET) == 0) &&
 541             (ifp->if_flags & (IFF_UP | IFF_LINK0)) == IFF_UP) {
 542                 mtx_unlock(&tp->tap_mtx);
 543                 if_down(ifp);
 544                 mtx_lock(&tp->tap_mtx);
 545                 if (ifp->if_drv_flags & IFF_DRV_RUNNING) {
 546                         ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
 547                         mtx_unlock(&tp->tap_mtx);
 548                         TAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) {
 549                                 rtinit(ifa, (int)RTM_DELETE, 0);
 550                         }
 551                         if_purgeaddrs(ifp);
 552                         mtx_lock(&tp->tap_mtx);
 553                 }
 554         }
 555
 556         if_link_state_change(ifp, LINK_STATE_DOWN);
 557         CURVNET_RESTORE();
 558
 559         funsetown(&tp->tap_sigio);
 560         selwakeuppri(&tp->tap_rsel, PZERO+1);
 561         KNOTE_LOCKED(&tp->tap_rsel.si_note, 0);
 562
 563         tp->tap_flags &= ~TAP_OPEN;
 564         tp->tap_pid = 0;
 565         mtx_unlock(&tp->tap_mtx);
 566
 567         TAPDEBUG("%s is closed. minor = %#x\n",
 568                 ifp->if_xname, dev2unit(dev));
 569
 570         return (0);
 571 } /* tapclose */
 572
 573
 574 /*
 575  * tapifinit
 576  *
 577  * network interface initialization function
 578  */
 579 static void
 580 tapifinit(void *xtp)
 581 {
 582         struct tap_softc        *tp = (struct tap_softc *)xtp;
 583         struct ifnet            *ifp = tp->tap_ifp;
 584
 585         TAPDEBUG("initializing %s\n", ifp->if_xname);
 586
 587         mtx_lock(&tp->tap_mtx);
 588         ifp->if_drv_flags |= IFF_DRV_RUNNING;
 589         ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
 590         mtx_unlock(&tp->tap_mtx);
 591
 592         /* attempt to start output */
 593         tapifstart(ifp);
 594 } /* tapifinit */
 595
 596
 597 /*
 598  * tapifioctl
 599  *
 600  * Process an ioctl request on network interface
 601  */
 602 static int
 603 tapifioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
 604 {
 605         struct tap_softc        *tp = ifp->if_softc;
 606         struct ifreq            *ifr = (struct ifreq *)data;
 607         struct ifstat           *ifs = NULL;
 608         struct ifmediareq       *ifmr = NULL;
 609         int                      dummy, error = 0;
 610
 611         switch (cmd) {
 612                 case SIOCSIFFLAGS: /* XXX -- just like vmnet does */
 613                 case SIOCADDMULTI:
 614                 case SIOCDELMULTI:
 615                         break;
 616
 617                 case SIOCGIFMEDIA:
 618                         ifmr = (struct ifmediareq *)data;
 619                         dummy = ifmr->ifm_count;
 620                         ifmr->ifm_count = 1;
 621                         ifmr->ifm_status = IFM_AVALID;
 622                         ifmr->ifm_active = IFM_ETHER;
 623                         if (tp->tap_flags & TAP_OPEN)
 624                                 ifmr->ifm_status |= IFM_ACTIVE;
 625                         ifmr->ifm_current = ifmr->ifm_active;
 626                         if (dummy >= 1) {
 627                                 int media = IFM_ETHER;
 628                                 error = copyout(&media, ifmr->ifm_ulist,
 629                                     sizeof(int));
 630                         }
 631                         break;
 632
 633                 case SIOCSIFMTU:
 634                         ifp->if_mtu = ifr->ifr_mtu;
 635                         break;
 636
 637                 case SIOCGIFSTATUS:
 638                         ifs = (struct ifstat *)data;
 639                         mtx_lock(&tp->tap_mtx);
 640                         if (tp->tap_pid != 0)
 641                                 snprintf(ifs->ascii, sizeof(ifs->ascii),
 642                                         "\tOpened by PID %d\n", tp->tap_pid);
 643                         else
 644                                 ifs->ascii[0] = '\0';
 645                         mtx_unlock(&tp->tap_mtx);
 646                         break;
 647
 648                 default:
 649                         error = ether_ioctl(ifp, cmd, data);
 650                         break;
 651         }
 652
 653         return (error);
 654 } /* tapifioctl */
 655
 656
 657 /*
 658  * tapifstart
 659  *
 660  * queue packets from higher level ready to put out
 661  */
 662 static void
 663 tapifstart(struct ifnet *ifp)
 664 {
 665         struct tap_softc        *tp = ifp->if_softc;
 666
 667         TAPDEBUG("%s starting\n", ifp->if_xname);
 668
 669         /*
 670          * do not junk pending output if we are in VMnet mode.
 671          * XXX: can this do any harm because of queue overflow?
 672          */
 673
 674         mtx_lock(&tp->tap_mtx);
 675         if (((tp->tap_flags & TAP_VMNET) == 0) &&
 676             ((tp->tap_flags & TAP_READY) != TAP_READY)) {
 677                 struct mbuf *m;
 678
 679                 /* Unlocked read. */
 680                 TAPDEBUG("%s not ready, tap_flags = 0x%x\n", ifp->if_xname,
 681                     tp->tap_flags);
 682
 683                 for (;;) {
 684                         IF_DEQUEUE(&ifp->if_snd, m);
 685                         if (m != NULL) {
 686                                 m_freem(m);
 687                                 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
 688                         } else
 689                                 break;
 690                 }
 691                 mtx_unlock(&tp->tap_mtx);
 692
 693                 return;
 694         }
 695
 696         ifp->if_drv_flags |= IFF_DRV_OACTIVE;
 697
 698         if (!IFQ_IS_EMPTY(&ifp->if_snd)) {
 699                 if (tp->tap_flags & TAP_RWAIT) {
 700                         tp->tap_flags &= ~TAP_RWAIT;
 701                         wakeup(tp);
 702                 }
 703
 704                 if ((tp->tap_flags & TAP_ASYNC) && (tp->tap_sigio != NULL)) {
 705                         mtx_unlock(&tp->tap_mtx);
 706                         pgsigio(&tp->tap_sigio, SIGIO, 0);
 707                         mtx_lock(&tp->tap_mtx);
 708                 }
 709
 710                 selwakeuppri(&tp->tap_rsel, PZERO+1);
 711                 KNOTE_LOCKED(&tp->tap_rsel.si_note, 0);
 712                 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1); /* obytes are counted in ether_output */
 713         }
 714
 715         ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
 716         mtx_unlock(&tp->tap_mtx);
 717 } /* tapifstart */
 718
 719
 720 /*
 721  * tapioctl
 722  *
 723  * the cdevsw interface is now pretty minimal
 724  */
 725 static int
 726 tapioctl(struct cdev *dev, u_long cmd, caddr_t data, int flag, struct thread *td)
 727 {
 728         struct tap_softc        *tp = dev->si_drv1;
 729         struct ifnet            *ifp = tp->tap_ifp;
 730         struct tapinfo          *tapp = NULL;
 731         int                      f;
 732 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
 733     defined(COMPAT_FREEBSD4)
 734         int                      ival;
 735 #endif
 736
 737         switch (cmd) {
 738                 case TAPSIFINFO:
 739                         tapp = (struct tapinfo *)data;
 740                         if (ifp->if_type != tapp->type)
 741                                 return (EPROTOTYPE);
 742                         mtx_lock(&tp->tap_mtx);
 743                         ifp->if_mtu = tapp->mtu;
 744                         ifp->if_baudrate = tapp->baudrate;
 745                         mtx_unlock(&tp->tap_mtx);
 746                         break;
 747
 748                 case TAPGIFINFO:
 749                         tapp = (struct tapinfo *)data;
 750                         mtx_lock(&tp->tap_mtx);
 751                         tapp->mtu = ifp->if_mtu;
 752                         tapp->type = ifp->if_type;
 753                         tapp->baudrate = ifp->if_baudrate;
 754                         mtx_unlock(&tp->tap_mtx);
 755                         break;
 756
 757                 case TAPSDEBUG:
 758                         tapdebug = *(int *)data;
 759                         break;
 760
 761                 case TAPGDEBUG:
 762                         *(int *)data = tapdebug;
 763                         break;
 764
 765                 case TAPGIFNAME: {
 766                         struct ifreq    *ifr = (struct ifreq *) data;
 767
 768                         strlcpy(ifr->ifr_name, ifp->if_xname, IFNAMSIZ);
 769                         } break;
 770
 771                 case FIONBIO:
 772                         break;
 773
 774                 case FIOASYNC:
 775                         mtx_lock(&tp->tap_mtx);
 776                         if (*(int *)data)
 777                                 tp->tap_flags |= TAP_ASYNC;
 778                         else
 779                                 tp->tap_flags &= ~TAP_ASYNC;
 780                         mtx_unlock(&tp->tap_mtx);
 781                         break;
 782
 783                 case FIONREAD:
 784                         if (!IFQ_IS_EMPTY(&ifp->if_snd)) {
 785                                 struct mbuf *mb;
 786
 787                                 IFQ_LOCK(&ifp->if_snd);
 788                                 IFQ_POLL_NOLOCK(&ifp->if_snd, mb);
 789                                 for (*(int *)data = 0; mb != NULL;
 790                                      mb = mb->m_next)
 791                                         *(int *)data += mb->m_len;
 792                                 IFQ_UNLOCK(&ifp->if_snd);
 793                         } else
 794                                 *(int *)data = 0;
 795                         break;
 796
 797                 case FIOSETOWN:
 798                         return (fsetown(*(int *)data, &tp->tap_sigio));
 799
 800                 case FIOGETOWN:
 801                         *(int *)data = fgetown(&tp->tap_sigio);
 802                         return (0);
 803
 804                 /* this is deprecated, FIOSETOWN should be used instead */
 805                 case TIOCSPGRP:
 806                         return (fsetown(-(*(int *)data), &tp->tap_sigio));
 807
 808                 /* this is deprecated, FIOGETOWN should be used instead */
 809                 case TIOCGPGRP:
 810                         *(int *)data = -fgetown(&tp->tap_sigio);
 811                         return (0);
 812
 813                 /* VMware/VMnet port ioctl's */
 814
 815 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
 816     defined(COMPAT_FREEBSD4)
 817                 case _IO('V', 0):
 818                         ival = IOCPARM_IVAL(data);
 819                         data = (caddr_t)&ival;
 820                         /* FALLTHROUGH */
 821 #endif
 822                 case VMIO_SIOCSIFFLAGS: /* VMware/VMnet SIOCSIFFLAGS */
 823                         f = *(int *)data;
 824                         f &= 0x0fff;
 825                         f &= ~IFF_CANTCHANGE;
 826                         f |= IFF_UP;
 827
 828                         mtx_lock(&tp->tap_mtx);
 829                         ifp->if_flags = f | (ifp->if_flags & IFF_CANTCHANGE);
 830                         mtx_unlock(&tp->tap_mtx);
 831                         break;
 832
 833                 case SIOCGIFADDR:       /* get MAC address of the remote side */
 834                         mtx_lock(&tp->tap_mtx);
 835                         bcopy(tp->ether_addr, data, sizeof(tp->ether_addr));
 836                         mtx_unlock(&tp->tap_mtx);
 837                         break;
 838
 839                 case SIOCSIFADDR:       /* set MAC address of the remote side */
 840                         mtx_lock(&tp->tap_mtx);
 841                         bcopy(data, tp->ether_addr, sizeof(tp->ether_addr));
 842                         mtx_unlock(&tp->tap_mtx);
 843                         break;
 844
 845                 default:
 846                         return (ENOTTY);
 847         }
 848         return (0);
 849 } /* tapioctl */
 850
 851
 852 /*
 853  * tapread
 854  *
 855  * the cdevsw read interface - reads a packet at a time, or at
 856  * least as much of a packet as can be read
 857  */
 858 static int
 859 tapread(struct cdev *dev, struct uio *uio, int flag)
 860 {
 861         struct tap_softc        *tp = dev->si_drv1;
 862         struct ifnet            *ifp = tp->tap_ifp;
 863         struct mbuf             *m = NULL;
 864         int                      error = 0, len;
 865
 866         TAPDEBUG("%s reading, minor = %#x\n", ifp->if_xname, dev2unit(dev));
 867
 868         mtx_lock(&tp->tap_mtx);
 869         if ((tp->tap_flags & TAP_READY) != TAP_READY) {
 870                 mtx_unlock(&tp->tap_mtx);
 871
 872                 /* Unlocked read. */
 873                 TAPDEBUG("%s not ready. minor = %#x, tap_flags = 0x%x\n",
 874                         ifp->if_xname, dev2unit(dev), tp->tap_flags);
 875
 876                 return (EHOSTDOWN);
 877         }
 878
 879         tp->tap_flags &= ~TAP_RWAIT;
 880
 881         /* sleep until we get a packet */
 882         do {
 883                 IF_DEQUEUE(&ifp->if_snd, m);
 884
 885                 if (m == NULL) {
 886                         if (flag & O_NONBLOCK) {
 887                                 mtx_unlock(&tp->tap_mtx);
 888                                 return (EWOULDBLOCK);
 889                         }
 890
 891                         tp->tap_flags |= TAP_RWAIT;
 892                         error = mtx_sleep(tp, &tp->tap_mtx, PCATCH | (PZERO + 1),
 893                             "taprd", 0);
 894                         if (error) {
 895                                 mtx_unlock(&tp->tap_mtx);
 896                                 return (error);
 897                         }
 898                 }
 899         } while (m == NULL);
 900         mtx_unlock(&tp->tap_mtx);
 901
 902         /* feed packet to bpf */
 903         BPF_MTAP(ifp, m);
 904
 905         /* xfer packet to user space */
 906         while ((m != NULL) && (uio->uio_resid > 0) && (error == 0)) {
 907                 len = min(uio->uio_resid, m->m_len);
 908                 if (len == 0)
 909                         break;
 910
 911                 error = uiomove(mtod(m, void *), len, uio);
 912                 m = m_free(m);
 913         }
 914
 915         if (m != NULL) {
 916                 TAPDEBUG("%s dropping mbuf, minor = %#x\n", ifp->if_xname,
 917                         dev2unit(dev));
 918                 m_freem(m);
 919         }
 920
 921         return (error);
 922 } /* tapread */
 923
 924
 925 /*
 926  * tapwrite
 927  *
 928  * the cdevsw write interface - an atomic write is a packet - or else!
 929  */
 930 static int
 931 tapwrite(struct cdev *dev, struct uio *uio, int flag)
 932 {
 933         struct ether_header     *eh;
 934         struct tap_softc        *tp = dev->si_drv1;
 935         struct ifnet            *ifp = tp->tap_ifp;
 936         struct mbuf             *m;
 937
 938         TAPDEBUG("%s writing, minor = %#x\n",
 939                 ifp->if_xname, dev2unit(dev));
 940
 941         if (uio->uio_resid == 0)
 942                 return (0);
 943
 944         if ((uio->uio_resid < 0) || (uio->uio_resid > TAPMRU)) {
 945                 TAPDEBUG("%s invalid packet len = %zd, minor = %#x\n",
 946                         ifp->if_xname, uio->uio_resid, dev2unit(dev));
 947
 948                 return (EIO);
 949         }
 950
 951         if ((m = m_uiotombuf(uio, M_NOWAIT, 0, ETHER_ALIGN,
 952             M_PKTHDR)) == NULL) {
 953                 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
 954                 return (ENOBUFS);
 955         }
 956
 957         m->m_pkthdr.rcvif = ifp;
 958
 959         /*
 960          * Only pass a unicast frame to ether_input(), if it would actually
 961          * have been received by non-virtual hardware.
 962          */
 963         if (m->m_len < sizeof(struct ether_header)) {
 964                 m_freem(m);
 965                 return (0);
 966         }
 967         eh = mtod(m, struct ether_header *);
 968
 969         if (eh && (ifp->if_flags & IFF_PROMISC) == 0 &&
 970             !ETHER_IS_MULTICAST(eh->ether_dhost) &&
 971             bcmp(eh->ether_dhost, IF_LLADDR(ifp), ETHER_ADDR_LEN) != 0) {
 972                 m_freem(m);
 973                 return (0);
 974         }
 975
 976         /* Pass packet up to parent. */
 977         CURVNET_SET(ifp->if_vnet);
 978         (*ifp->if_input)(ifp, m);
 979         CURVNET_RESTORE();
 980         if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1); /* ibytes are counted in parent */
 981
 982         return (0);
 983 } /* tapwrite */
 984
 985
 986 /*
 987  * tappoll
 988  *
 989  * the poll interface, this is only useful on reads
 990  * really. the write detect always returns true, write never blocks
 991  * anyway, it either accepts the packet or drops it
 992  */
 993 static int
 994 tappoll(struct cdev *dev, int events, struct thread *td)
 995 {
 996         struct tap_softc        *tp = dev->si_drv1;
 997         struct ifnet            *ifp = tp->tap_ifp;
 998         int                      revents = 0;
 999
1000         TAPDEBUG("%s polling, minor = %#x\n",
1001                 ifp->if_xname, dev2unit(dev));
1002
1003         if (events & (POLLIN | POLLRDNORM)) {
1004                 IFQ_LOCK(&ifp->if_snd);
1005                 if (!IFQ_IS_EMPTY(&ifp->if_snd)) {
1006                         TAPDEBUG("%s have data in queue. len = %d, " \
1007                                 "minor = %#x\n", ifp->if_xname,
1008                                 ifp->if_snd.ifq_len, dev2unit(dev));
1009
1010                         revents |= (events & (POLLIN | POLLRDNORM));
1011                 } else {
1012                         TAPDEBUG("%s waiting for data, minor = %#x\n",
1013                                 ifp->if_xname, dev2unit(dev));
1014
1015                         selrecord(td, &tp->tap_rsel);
1016                 }
1017                 IFQ_UNLOCK(&ifp->if_snd);
1018         }
1019
1020         if (events & (POLLOUT | POLLWRNORM))
1021                 revents |= (events & (POLLOUT | POLLWRNORM));
1022
1023         return (revents);
1024 } /* tappoll */
1025
1026
1027 /*
1028  * tap_kqfilter
1029  *
1030  * support for kevent() system call
1031  */
1032 static int
1033 tapkqfilter(struct cdev *dev, struct knote *kn)
1034 {
1035         struct tap_softc        *tp = dev->si_drv1;
1036         struct ifnet            *ifp = tp->tap_ifp;
1037
1038         switch (kn->kn_filter) {
1039         case EVFILT_READ:
1040                 TAPDEBUG("%s kqfilter: EVFILT_READ, minor = %#x\n",
1041                         ifp->if_xname, dev2unit(dev));
1042                 kn->kn_fop = &tap_read_filterops;
1043                 break;
1044
1045         case EVFILT_WRITE:
1046                 TAPDEBUG("%s kqfilter: EVFILT_WRITE, minor = %#x\n",
1047                         ifp->if_xname, dev2unit(dev));
1048                 kn->kn_fop = &tap_write_filterops;
1049                 break;
1050
1051         default:
1052                 TAPDEBUG("%s kqfilter: invalid filter, minor = %#x\n",
1053                         ifp->if_xname, dev2unit(dev));
1054                 return (EINVAL);
1055                 /* NOT REACHED */
1056         }
1057
1058         kn->kn_hook = tp;
1059         knlist_add(&tp->tap_rsel.si_note, kn, 0);
1060
1061         return (0);
1062 } /* tapkqfilter */
1063
1064
1065 /*
1066  * tap_kqread
1067  *
1068  * Return true if there is data in the interface queue
1069  */
1070 static int
1071 tapkqread(struct knote *kn, long hint)
1072 {
1073         int                      ret;
1074         struct tap_softc        *tp = kn->kn_hook;
1075         struct cdev             *dev = tp->tap_dev;
1076         struct ifnet            *ifp = tp->tap_ifp;
1077
1078         if ((kn->kn_data = ifp->if_snd.ifq_len) > 0) {
1079                 TAPDEBUG("%s have data in queue. len = %d, minor = %#x\n",
1080                         ifp->if_xname, ifp->if_snd.ifq_len, dev2unit(dev));
1081                 ret = 1;
1082         } else {
1083                 TAPDEBUG("%s waiting for data, minor = %#x\n",
1084                         ifp->if_xname, dev2unit(dev));
1085                 ret = 0;
1086         }
1087
1088         return (ret);
1089 } /* tapkqread */
1090
1091
1092 /*
1093  * tap_kqwrite
1094  *
1095  * Always can write. Return the MTU in kn->data
1096  */
1097 static int
1098 tapkqwrite(struct knote *kn, long hint)
1099 {
1100         struct tap_softc        *tp = kn->kn_hook;
1101         struct ifnet            *ifp = tp->tap_ifp;
1102
1103         kn->kn_data = ifp->if_mtu;
1104
1105         return (1);
1106 } /* tapkqwrite */
1107
1108
1109 static void
1110 tapkqdetach(struct knote *kn)
1111 {
1112         struct tap_softc        *tp = kn->kn_hook;
1113
1114         knlist_remove(&tp->tap_rsel.si_note, kn, 0);
1115 } /* tapkqdetach */
1116