bsd/net/ndrv.c

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /* Copyright (c) 1997, 1998 Apple Computer, Inc. All Rights Reserved */
  23 /*
  24  *      @(#)ndrv.c      1.1 (MacOSX) 6/10/43
  25  * Justin Walker, 970604
  26  *   AF_NDRV support
  27  * 980130 - Cleanup, reorg, performance improvemements
  28  * 000816 - Removal of Y adapter cruft
  29  */
  30
  31 /*
  32  * PF_NDRV allows raw access to a specified network device, directly
  33  *  with a socket.  Expected use involves a socket option to request
  34  *  protocol packets.  This lets ndrv_output() call dlil_output(), and
  35  *  lets DLIL find the proper recipient for incoming packets.
  36  *  The purpose here is for user-mode protocol implementation.
  37  * Note that "pure raw access" will still be accomplished with BPF.
  38  *
  39  * In addition to the former use, when combined with socket NKEs,
  40  * PF_NDRV permits a fairly flexible mechanism for implementing
  41  * strange protocol support.  One of the main ones will be the
  42  * BlueBox/Classic Shared IP Address support.
  43  */
  44 #include <mach/mach_types.h>
  45
  46 #include <sys/param.h>
  47 #include <sys/systm.h>
  48 #include <sys/kernel.h>
  49 #include <sys/malloc.h>
  50 #include <sys/mbuf.h>
  51 #include <sys/protosw.h>
  52 #include <sys/domain.h>
  53 #include <sys/socket.h>
  54 #include <sys/socketvar.h>
  55 #include <sys/ioctl.h>
  56 #include <sys/errno.h>
  57 #include <sys/syslog.h>
  58 #include <sys/proc.h>
  59
  60 #include <kern/queue.h>
  61
  62 #include <net/ndrv.h>
  63 #include <net/route.h>
  64 #include <net/if_llc.h>
  65 #include <net/if_dl.h>
  66 #include <net/if_types.h>
  67 #include <net/ndrv_var.h>
  68
  69 #if INET
  70 #include <netinet/in.h>
  71 #include <netinet/in_var.h>
  72 #endif
  73 #include <netinet/if_ether.h>
  74
  75 #include <machine/spl.h>
  76
  77 static int ndrv_do_detach(struct ndrv_cb *);
  78 static int ndrv_do_disconnect(struct ndrv_cb *);
  79 static struct ndrv_cb *ndrv_find_inbound(struct ifnet *ifp, u_long protocol_family);
  80 static int ndrv_setspec(struct ndrv_cb *np, struct sockopt *sopt);
  81 static int ndrv_delspec(struct ndrv_cb *);
  82 static int ndrv_to_dlil_demux(struct ndrv_demux_desc* ndrv, struct dlil_demux_desc* dlil);
  83 static void ndrv_handle_ifp_detach(u_long family, short unit);
  84 static int ndrv_do_add_multicast(struct ndrv_cb *np, struct sockopt *sopt);
  85 static int ndrv_do_remove_multicast(struct ndrv_cb *np, struct sockopt *sopt);
  86 static struct ndrv_multiaddr* ndrv_have_multicast(struct ndrv_cb *np, struct sockaddr* addr);
  87 static void ndrv_remove_all_multicast(struct ndrv_cb *np);
  88
  89 unsigned long  ndrv_sendspace = NDRVSNDQ;
  90 unsigned long  ndrv_recvspace = NDRVRCVQ;
  91 TAILQ_HEAD(, ndrv_cb)   ndrvl = TAILQ_HEAD_INITIALIZER(ndrvl);
  92
  93 extern struct domain ndrvdomain;
  94 extern struct protosw ndrvsw;
  95 extern lck_mtx_t *domain_proto_mtx;
  96
  97 extern void kprintf(const char *, ...);
  98
  99 /*
 100  * Verify these values match.
 101  * To keep clients from including dlil.h, we define
 102  * these values independently in ndrv.h. They must
 103  * match or a conversion function must be written.
 104  */
 105 #if NDRV_DEMUXTYPE_ETHERTYPE != DLIL_DESC_ETYPE2
 106 #error NDRV_DEMUXTYPE_ETHERTYPE must match DLIL_DESC_ETYPE2
 107 #endif
 108 #if NDRV_DEMUXTYPE_SAP != DLIL_DESC_SAP
 109 #error NDRV_DEMUXTYPE_SAP must match DLIL_DESC_SAP
 110 #endif
 111 #if NDRV_DEMUXTYPE_SNAP != DLIL_DESC_SNAP
 112 #error NDRV_DEMUXTYPE_SNAP must match DLIL_DESC_SNAP
 113 #endif
 114
 115 /*
 116  * Protocol output - Called to output a raw network packet directly
 117  *  to the driver.
 118  */
 119 static int
 120 ndrv_output(struct mbuf *m, struct socket *so)
 121 {
 122     struct ndrv_cb *np = sotondrvcb(so);
 123         struct ifnet *ifp = np->nd_if;
 124     int result = 0;
 125
 126 #if NDRV_DEBUG
 127         kprintf("NDRV output: %x, %x, %x\n", m, so, np);
 128 #endif
 129
 130         /*
 131          * No header is a format error
 132          */
 133         if ((m->m_flags&M_PKTHDR) == 0)
 134                 return(EINVAL);
 135
 136         /* Unlock before calling dlil_output */
 137         socket_unlock(so, 0);
 138
 139         /*
 140      * Call DLIL if we can. DLIL is much safer than calling the
 141      * ifp directly.
 142      */
 143         result = dlil_output(ifp, np->nd_proto_family, m, (caddr_t)NULL,
 144                                                 (struct sockaddr*)NULL, 1);
 145
 146         socket_lock(so, 0);
 147
 148         return (result);
 149 }
 150
 151 /* Our input routine called from DLIL */
 152 static int
 153 ndrv_input(struct mbuf *m,
 154            char *frame_header,
 155            struct ifnet *ifp,
 156            u_long  proto_family,
 157            __unused int sync_ok)
 158 {
 159         struct socket *so;
 160         struct sockaddr_dl ndrvsrc = {sizeof (struct sockaddr_dl), AF_NDRV};
 161         struct ndrv_cb *np;
 162         int error = 0;
 163
 164
 165     /* move packet from if queue to socket */
 166         /* Should be media-independent */
 167     ndrvsrc.sdl_type = IFT_ETHER;
 168     ndrvsrc.sdl_nlen = 0;
 169     ndrvsrc.sdl_alen = 6;
 170     ndrvsrc.sdl_slen = 0;
 171     bcopy(frame_header, &ndrvsrc.sdl_data, 6);
 172
 173         np = ndrv_find_inbound(ifp, proto_family);
 174         if (np == NULL)
 175         {
 176                 return(ENOENT);
 177         }
 178         so = np->nd_socket;
 179     /* prepend the frame header */
 180     m = m_prepend(m, ifp->if_hdrlen, M_NOWAIT);
 181     if (m == NULL)
 182         return EJUSTRETURN;
 183     bcopy(frame_header, m->m_data, ifp->if_hdrlen);
 184
 185         lck_mtx_assert(so->so_proto->pr_domain->dom_mtx, LCK_MTX_ASSERT_NOTOWNED);
 186         lck_mtx_lock(so->so_proto->pr_domain->dom_mtx);
 187         if (sbappendaddr(&(so->so_rcv), (struct sockaddr *)&ndrvsrc,
 188                                          m, (struct mbuf *)0, &error) != 0) {
 189                 sorwakeup(so);
 190         }
 191         lck_mtx_unlock(so->so_proto->pr_domain->dom_mtx);
 192         return 0; /* radar 4030377 - always return 0 */
 193 }
 194
 195 /*
 196  * Allocate an ndrv control block and some buffer space for the socket
 197  */
 198 static int
 199 ndrv_attach(struct socket *so, int proto, __unused struct proc *p)
 200 {
 201     int error;
 202         struct ndrv_cb *np = sotondrvcb(so);
 203
 204         if ((so->so_state & SS_PRIV) == 0)
 205                 return(EPERM);
 206
 207 #if NDRV_DEBUG
 208         kprintf("NDRV attach: %x, %x, %x\n", so, proto, np);
 209 #endif
 210
 211         if ((error = soreserve(so, ndrv_sendspace, ndrv_recvspace)))
 212                 return(error);
 213
 214         MALLOC(np, struct ndrv_cb *, sizeof(*np), M_PCB, M_WAITOK);
 215         if (np == NULL)
 216                 return (ENOMEM);
 217     so->so_pcb = (caddr_t)np;
 218     bzero(np, sizeof(*np));
 219 #if NDRV_DEBUG
 220         kprintf("NDRV attach: %x, %x, %x\n", so, proto, np);
 221 #endif
 222         TAILQ_INIT(&np->nd_dlist);
 223         np->nd_signature = NDRV_SIGNATURE;
 224         np->nd_socket = so;
 225         np->nd_proto.sp_family = so->so_proto->pr_domain->dom_family;
 226         np->nd_proto.sp_protocol = proto;
 227     np->nd_if = NULL;
 228     np->nd_proto_family = 0;
 229     np->nd_family = 0;
 230     np->nd_unit = 0;
 231     TAILQ_INSERT_TAIL(&ndrvl, np, nd_next);
 232         return(0);
 233 }
 234
 235 /*
 236  * Destroy state just before socket deallocation.
 237  * Flush data or not depending on the options.
 238  */
 239
 240 static int
 241 ndrv_detach(struct socket *so)
 242 {
 243         struct ndrv_cb *np = sotondrvcb(so);
 244
 245         if (np == 0)
 246                 return EINVAL;
 247         return ndrv_do_detach(np);
 248 }
 249
 250
 251 /*
 252  * If a socket isn't bound to a single address,
 253  * the ndrv input routine will hand it anything
 254  * within that protocol family (assuming there's
 255  * nothing else around it should go to).
 256  *
 257  * Don't expect this to be used.
 258  */
 259
 260 static int
 261 ndrv_connect(struct socket *so, struct sockaddr *nam, __unused struct proc *p)
 262 {
 263         struct ndrv_cb *np = sotondrvcb(so);
 264     int result = 0;
 265
 266         if (np == 0)
 267                 return EINVAL;
 268
 269         if (np->nd_faddr)
 270                 return EISCONN;
 271
 272     /* Allocate memory to store the remote address */
 273     MALLOC(np->nd_faddr, struct sockaddr_ndrv*,
 274                 nam->sa_len, M_IFADDR, M_WAITOK);
 275     if (result != 0)
 276         return result;
 277     if (np->nd_faddr == NULL)
 278         return ENOMEM;
 279
 280         bcopy((caddr_t) nam, (caddr_t) np->nd_faddr, nam->sa_len);
 281         soisconnected(so);
 282         return 0;
 283 }
 284
 285 static void
 286 ndrv_event(struct ifnet *ifp, struct kev_msg *event)
 287 {
 288         if (event->vendor_code == KEV_VENDOR_APPLE &&
 289                 event->kev_class == KEV_NETWORK_CLASS &&
 290                 event->kev_subclass == KEV_DL_SUBCLASS &&
 291                 event->event_code == KEV_DL_IF_DETACHING) {
 292                 ndrv_handle_ifp_detach(ifp->if_family, ifp->if_unit);
 293         }
 294 }
 295
 296 static int name_cmp(struct ifnet *, char *);
 297
 298 /*
 299  * This is the "driver open" hook - we 'bind' to the
 300  *  named driver.
 301  * Here's where we latch onto the driver.
 302  */
 303 static int
 304 ndrv_bind(struct socket *so, struct sockaddr *nam, __unused struct proc *p)
 305 {
 306     struct sockaddr_ndrv *sa = (struct sockaddr_ndrv *) nam;
 307         char *dname;
 308         struct ndrv_cb *np;
 309         struct ifnet *ifp;
 310     int result;
 311
 312         if TAILQ_EMPTY(&ifnet_head)
 313                 return(EADDRNOTAVAIL); /* Quick sanity check */
 314         np = sotondrvcb(so);
 315         if (np == 0)
 316                 return EINVAL;
 317
 318         if (np->nd_laddr)
 319                 return EINVAL;                  /* XXX */
 320
 321         /* I think we just latch onto a copy here; the caller frees */
 322         np->nd_laddr = _MALLOC(sizeof(struct sockaddr_ndrv), M_IFADDR, M_WAITOK);
 323         if (np->nd_laddr == NULL)
 324                 return(ENOMEM);
 325         bcopy((caddr_t) sa, (caddr_t) np->nd_laddr, sizeof(struct sockaddr_ndrv));
 326         dname = sa->snd_name;
 327         if (*dname == '\0')
 328                 return(EINVAL);
 329 #if NDRV_DEBUG
 330         kprintf("NDRV bind: %x, %x, %s\n", so, np, dname);
 331 #endif
 332         /* Track down the driver and its ifnet structure.
 333          * There's no internal call for this so we have to dup the code
 334          *  in if.c/ifconf()
 335          */
 336         ifnet_head_lock_shared();
 337         TAILQ_FOREACH(ifp, &ifnet_head, if_link) {
 338                 if (name_cmp(ifp, dname) == 0)
 339                         break;
 340         }
 341         ifnet_head_done();
 342
 343         if (ifp == NULL)
 344                 return(EADDRNOTAVAIL);
 345
 346         // PPP doesn't support PF_NDRV.
 347         if (ifp->if_family != APPLE_IF_FAM_PPP)
 348         {
 349                 /* NDRV on this interface */
 350                 struct dlil_proto_reg_str       ndrv_proto;
 351                 result = 0;
 352                 bzero(&ndrv_proto, sizeof(ndrv_proto));
 353                 TAILQ_INIT(&ndrv_proto.demux_desc_head);
 354
 355                 ndrv_proto.interface_family = ifp->if_family;
 356                 ndrv_proto.protocol_family = PF_NDRV;
 357                 ndrv_proto.unit_number = ifp->if_unit;
 358                 ndrv_proto.event = ndrv_event;
 359
 360                 /* We aren't worried about double attaching, that should just return an error */
 361                 result = dlil_attach_protocol(&ndrv_proto);
 362                 if (result && result != EEXIST) {
 363                         return result;
 364                 }
 365                 np->nd_proto_family = PF_NDRV;
 366         }
 367         else {
 368                 np->nd_proto_family = 0;
 369         }
 370
 371         np->nd_if = ifp;
 372     np->nd_family = ifp->if_family;
 373     np->nd_unit = ifp->if_unit;
 374
 375         return(0);
 376 }
 377
 378 static int
 379 ndrv_disconnect(struct socket *so)
 380 {
 381         struct ndrv_cb *np = sotondrvcb(so);
 382
 383         if (np == 0)
 384                 return EINVAL;
 385
 386         if (np->nd_faddr == 0)
 387                 return ENOTCONN;
 388
 389         ndrv_do_disconnect(np);
 390         return 0;
 391 }
 392
 393 /*
 394  * Mark the connection as being incapable of further input.
 395  */
 396 static int
 397 ndrv_shutdown(struct socket *so)
 398 {
 399         lck_mtx_assert(so->so_proto->pr_domain->dom_mtx, LCK_MTX_ASSERT_OWNED);
 400         socantsendmore(so);
 401         return 0;
 402 }
 403
 404 /*
 405  * Ship a packet out.  The ndrv output will pass it
 406  *  to the appropriate driver.  The really tricky part
 407  *  is the destination address...
 408  */
 409 static int
 410 ndrv_send(struct socket *so, __unused int flags, struct mbuf *m,
 411           __unused struct sockaddr *addr, struct mbuf *control,
 412           __unused struct proc *p)
 413 {
 414         int error;
 415
 416         if (control)
 417                 return EOPNOTSUPP;
 418
 419         error = ndrv_output(m, so);
 420         m = NULL;
 421         return error;
 422 }
 423
 424
 425 static int
 426 ndrv_abort(struct socket *so)
 427 {
 428         struct ndrv_cb *np = sotondrvcb(so);
 429
 430         if (np == 0)
 431                 return EINVAL;
 432
 433         ndrv_do_disconnect(np);
 434         return 0;
 435 }
 436
 437 static int
 438 ndrv_sockaddr(struct socket *so, struct sockaddr **nam)
 439 {
 440         struct ndrv_cb *np = sotondrvcb(so);
 441         int len;
 442
 443         if (np == 0)
 444                 return EINVAL;
 445
 446         if (np->nd_laddr == 0)
 447                 return EINVAL;
 448
 449         len = np->nd_laddr->snd_len;
 450         MALLOC(*nam, struct sockaddr *, len, M_SONAME, M_WAITOK);
 451         if (*nam == NULL)
 452                 return ENOMEM;
 453         bcopy((caddr_t)np->nd_laddr, *nam,
 454               (unsigned)len);
 455         return 0;
 456 }
 457
 458
 459 static int
 460 ndrv_peeraddr(struct socket *so, struct sockaddr **nam)
 461 {
 462         struct ndrv_cb *np = sotondrvcb(so);
 463         int len;
 464
 465         if (np == 0)
 466                 return EINVAL;
 467
 468         if (np->nd_faddr == 0)
 469                 return ENOTCONN;
 470
 471         len = np->nd_faddr->snd_len;
 472         MALLOC(*nam, struct sockaddr *, len, M_SONAME, M_WAITOK);
 473         if (*nam == NULL)
 474                 return ENOMEM;
 475         bcopy((caddr_t)np->nd_faddr, *nam,
 476               (unsigned)len);
 477         return 0;
 478 }
 479
 480
 481 /* Control output */
 482
 483 static int
 484 ndrv_ctloutput(struct socket *so, struct sockopt *sopt)
 485 {
 486     struct ndrv_cb *np = sotondrvcb(so);
 487         int error = 0;
 488
 489     switch(sopt->sopt_name)
 490     {
 491         case NDRV_DELDMXSPEC: /* Delete current spec */
 492             /* Verify no parameter was passed */
 493             if (sopt->sopt_val != NULL || sopt->sopt_valsize != 0) {
 494                 /*
 495                  * We don't support deleting a specific demux, it's
 496                  * all or nothing.
 497                  */
 498                 return EINVAL;
 499             }
 500             error = ndrv_delspec(np);
 501             break;
 502         case NDRV_SETDMXSPEC: /* Set protocol spec */
 503             error = ndrv_setspec(np, sopt);
 504             break;
 505         case NDRV_ADDMULTICAST:
 506             error = ndrv_do_add_multicast(np, sopt);
 507             break;
 508         case NDRV_DELMULTICAST:
 509             error = ndrv_do_remove_multicast(np, sopt);
 510             break;
 511         default:
 512             error = ENOTSUP;
 513     }
 514 #ifdef NDRV_DEBUG
 515         log(LOG_WARNING, "NDRV CTLOUT: %x returns %d\n", sopt->sopt_name,
 516             error);
 517 #endif
 518         return(error);
 519 }
 520
 521 static int
 522 ndrv_do_detach(struct ndrv_cb *np)
 523 {
 524     struct ndrv_cb*     cur_np = NULL;
 525     struct socket *so = np->nd_socket;
 526     int error = 0;
 527
 528 #if NDRV_DEBUG
 529         kprintf("NDRV detach: %x, %x\n", so, np);
 530 #endif
 531     ndrv_remove_all_multicast(np);
 532
 533     if (np->nd_if) {
 534                 if (np->nd_proto_family != PF_NDRV &&
 535                         np->nd_proto_family != 0) {
 536                         dlil_detach_protocol(np->nd_if, np->nd_proto_family);
 537                 }
 538
 539                 /* Remove from the linked list of control blocks */
 540                 TAILQ_REMOVE(&ndrvl, np, nd_next);
 541
 542                 /* Check if this is the last socket attached to this interface */
 543                 TAILQ_FOREACH(cur_np, &ndrvl, nd_next) {
 544                         if (cur_np->nd_family == np->nd_family &&
 545                                 cur_np->nd_unit == np->nd_unit) {
 546                                 break;
 547                         }
 548                 }
 549
 550                 /* If there are no other interfaces, detach PF_NDRV from the interface */
 551                 if (cur_np == NULL) {
 552                         dlil_detach_protocol(np->nd_if, PF_NDRV);
 553                 }
 554         }
 555
 556         FREE((caddr_t)np, M_PCB);
 557         so->so_pcb = 0;
 558         so->so_flags |= SOF_PCBCLEARING;
 559         sofree(so);
 560         return error;
 561 }
 562
 563 static int
 564 ndrv_do_disconnect(struct ndrv_cb *np)
 565 {
 566 #if NDRV_DEBUG
 567         kprintf("NDRV disconnect: %x\n", np);
 568 #endif
 569         if (np->nd_faddr)
 570         {
 571         FREE(np->nd_faddr, M_IFADDR);
 572                 np->nd_faddr = 0;
 573         }
 574         if (np->nd_socket->so_state & SS_NOFDREF)
 575                 ndrv_do_detach(np);
 576         soisdisconnected(np->nd_socket);
 577         return(0);
 578 }
 579
 580 /* Hackery - return a string version of a decimal number */
 581 static char *
 582 sprint_d(u_int n, char *buf, int buflen)
 583 {       char dbuf[IFNAMSIZ];
 584         char *cp = dbuf+IFNAMSIZ-1;
 585
 586         *cp = 0;
 587         do {    buflen--;
 588                 cp--;
 589                 *cp = "0123456789"[n % 10];
 590                 n /= 10;
 591         } while (n != 0 && buflen > 0);
 592         strncpy(buf, cp, IFNAMSIZ-buflen);
 593         return (cp);
 594 }
 595
 596 /*
 597  * Try to compare a device name (q) with one of the funky ifnet
 598  *  device names (ifp).
 599  */
 600 static int name_cmp(struct ifnet *ifp, char *q)
 601 {       char *r;
 602         int len;
 603         char buf[IFNAMSIZ];
 604
 605         r = buf;
 606         len = strlen(ifp->if_name);
 607         strncpy(r, ifp->if_name, IFNAMSIZ);
 608         r += len;
 609         (void)sprint_d(ifp->if_unit, r, IFNAMSIZ-(r-buf));
 610 #if NDRV_DEBUG
 611         kprintf("Comparing %s, %s\n", buf, q);
 612 #endif
 613         return(strncmp(buf, q, IFNAMSIZ));
 614 }
 615
 616 #if 0
 617 //### Not used
 618 /*
 619  * When closing, dump any enqueued mbufs.
 620  */
 621 void
 622 ndrv_flushq(struct ifqueue *q)
 623 {
 624     struct mbuf *m;
 625         for (;;)
 626         {
 627                 IF_DEQUEUE(q, m);
 628                 if (m == NULL)
 629                         break;
 630                 IF_DROP(q);
 631                 if (m)
 632                         m_freem(m);
 633         }
 634 }
 635 #endif
 636
 637 int
 638 ndrv_setspec(struct ndrv_cb *np, struct sockopt *sopt)
 639 {
 640     struct dlil_proto_reg_str   dlilSpec;
 641     struct ndrv_protocol_desc   ndrvSpec;
 642     struct dlil_demux_desc*             dlilDemux = NULL;
 643     struct ndrv_demux_desc*             ndrvDemux = NULL;
 644     int                                                 error = 0;
 645
 646     /* Sanity checking */
 647     if (np->nd_proto_family != PF_NDRV)
 648         return EBUSY;
 649     if (np->nd_if == NULL)
 650         return EINVAL;
 651     if (sopt->sopt_valsize != sizeof(struct ndrv_protocol_desc))
 652         return EINVAL;
 653
 654     /* Copy the ndrvSpec */
 655     error = sooptcopyin(sopt, &ndrvSpec, sizeof(struct ndrv_protocol_desc),
 656                         sizeof(struct ndrv_protocol_desc));
 657     if (error != 0)
 658         return error;
 659
 660     /* Verify the parameter */
 661     if (ndrvSpec.version > NDRV_PROTOCOL_DESC_VERS)
 662         return ENOTSUP; // version is too new!
 663     else if (ndrvSpec.version < 1)
 664         return EINVAL; // version is not valid
 665
 666     /* Allocate storage for demux array */
 667     MALLOC(ndrvDemux, struct ndrv_demux_desc*,
 668             ndrvSpec.demux_count * sizeof(struct ndrv_demux_desc), M_TEMP, M_WAITOK);
 669     if (ndrvDemux == NULL)
 670         return ENOMEM;
 671
 672     /* Allocate enough dlil_demux_descs */
 673     MALLOC(dlilDemux, struct dlil_demux_desc*,
 674             sizeof(*dlilDemux) * ndrvSpec.demux_count, M_TEMP, M_WAITOK);
 675     if (dlilDemux == NULL)
 676         error = ENOMEM;
 677
 678     if (error == 0)
 679     {
 680         /* Copy the ndrv demux array from userland */
 681         error = copyin(CAST_USER_ADDR_T(ndrvSpec.demux_list), ndrvDemux,
 682                     ndrvSpec.demux_count * sizeof(struct ndrv_demux_desc));
 683         ndrvSpec.demux_list = ndrvDemux;
 684     }
 685
 686     if (error == 0)
 687     {
 688         /* At this point, we've at least got enough bytes to start looking around */
 689         u_long  demuxOn = 0;
 690
 691         bzero(&dlilSpec, sizeof(dlilSpec));
 692         TAILQ_INIT(&dlilSpec.demux_desc_head);
 693         dlilSpec.interface_family = np->nd_family;
 694         dlilSpec.unit_number = np->nd_unit;
 695         dlilSpec.input = ndrv_input;
 696                 dlilSpec.event = ndrv_event;
 697         dlilSpec.protocol_family = ndrvSpec.protocol_family;
 698
 699         for (demuxOn = 0; demuxOn < ndrvSpec.demux_count; demuxOn++)
 700         {
 701             /* Convert an ndrv_demux_desc to a dlil_demux_desc */
 702             error = ndrv_to_dlil_demux(&ndrvSpec.demux_list[demuxOn], &dlilDemux[demuxOn]);
 703             if (error)
 704                 break;
 705
 706             /* Add the dlil_demux_desc to the list */
 707             TAILQ_INSERT_TAIL(&dlilSpec.demux_desc_head, &dlilDemux[demuxOn], next);
 708         }
 709     }
 710
 711     if (error == 0)
 712     {
 713         /* We've got all our ducks lined up...lets attach! */
 714         error = dlil_attach_protocol(&dlilSpec);
 715         if (error == 0)
 716                 np->nd_proto_family = dlilSpec.protocol_family;
 717     }
 718
 719     /* Free any memory we've allocated */
 720     if (dlilDemux)
 721         FREE(dlilDemux, M_TEMP);
 722     if (ndrvDemux)
 723         FREE(ndrvDemux, M_TEMP);
 724
 725     return error;
 726 }
 727
 728
 729 int
 730 ndrv_to_dlil_demux(struct ndrv_demux_desc* ndrv, struct dlil_demux_desc* dlil)
 731 {
 732     bzero(dlil, sizeof(*dlil));
 733
 734     if (ndrv->type < DLIL_DESC_ETYPE2)
 735     {
 736         /* using old "type", not supported */
 737         return ENOTSUP;
 738     }
 739
 740     if (ndrv->length > 28)
 741     {
 742         return EINVAL;
 743     }
 744
 745     dlil->type = ndrv->type;
 746     dlil->native_type = ndrv->data.other;
 747     dlil->variants.native_type_length = ndrv->length;
 748
 749     return 0;
 750 }
 751
 752 int
 753 ndrv_delspec(struct ndrv_cb *np)
 754 {
 755     int result = 0;
 756
 757     if (np->nd_proto_family == PF_NDRV ||
 758         np->nd_proto_family == 0)
 759         return EINVAL;
 760
 761     /* Detach the protocol */
 762     result = dlil_detach_protocol(np->nd_if, np->nd_proto_family);
 763     np->nd_proto_family = PF_NDRV;
 764
 765         return result;
 766 }
 767
 768 struct ndrv_cb *
 769 ndrv_find_inbound(struct ifnet *ifp, u_long protocol)
 770 {
 771     struct ndrv_cb* np;
 772
 773         if (protocol == PF_NDRV) return NULL;
 774
 775     TAILQ_FOREACH(np, &ndrvl, nd_next) {
 776         if (np->nd_proto_family == protocol &&
 777                 np->nd_if == ifp) {
 778             return np;
 779         }
 780     }
 781
 782         return NULL;
 783 }
 784
 785 static void ndrv_dominit(void)
 786 {
 787         static int ndrv_dominited = 0;
 788
 789         if (ndrv_dominited == 0 &&
 790             net_add_proto(&ndrvsw, &ndrvdomain) == 0)
 791                 ndrv_dominited = 1;
 792 }
 793
 794 static void
 795 ndrv_handle_ifp_detach(u_long family, short unit)
 796 {
 797     struct ndrv_cb* np;
 798     struct ifnet        *ifp = NULL;
 799     struct socket *so;
 800
 801     /* Find all sockets using this interface. */
 802     TAILQ_FOREACH(np, &ndrvl, nd_next) {
 803         if (np->nd_family == family &&
 804             np->nd_unit == unit)
 805         {
 806             /* This cb is using the detaching interface, but not for long. */
 807             /* Let the protocol go */
 808             ifp = np->nd_if;
 809             if (np->nd_proto_family != 0)
 810                 ndrv_delspec(np);
 811
 812             /* Delete the multicasts first */
 813             ndrv_remove_all_multicast(np);
 814
 815             /* Disavow all knowledge of the ifp */
 816             np->nd_if = NULL;
 817             np->nd_unit = 0;
 818             np->nd_family = 0;
 819
 820                   so = np->nd_socket;
 821             /* Make sure sending returns an error */
 822             /* Is this safe? Will we drop the funnel? */
 823                   lck_mtx_assert(so->so_proto->pr_domain->dom_mtx, LCK_MTX_ASSERT_OWNED);
 824             socantsendmore(so);
 825             socantrcvmore(so);
 826         }
 827     }
 828
 829     /* Unregister our protocol */
 830     if (ifp) {
 831         dlil_detach_protocol(ifp, PF_NDRV);
 832     }
 833 }
 834
 835 static int
 836 ndrv_do_add_multicast(struct ndrv_cb *np, struct sockopt *sopt)
 837 {
 838     struct ndrv_multiaddr*      ndrv_multi;
 839     int                                         result;
 840
 841     if (sopt->sopt_val == NULL || sopt->sopt_valsize < 2 ||
 842         sopt->sopt_level != SOL_NDRVPROTO)
 843         return EINVAL;
 844     if (np->nd_if == NULL)
 845         return ENXIO;
 846
 847     // Allocate storage
 848     MALLOC(ndrv_multi, struct ndrv_multiaddr*, sizeof(struct ndrv_multiaddr) -
 849         sizeof(struct sockaddr) + sopt->sopt_valsize, M_IFADDR, M_WAITOK);
 850     if (ndrv_multi == NULL)
 851         return ENOMEM;
 852
 853     // Copy in the address
 854     result = copyin(sopt->sopt_val, &ndrv_multi->addr, sopt->sopt_valsize);
 855
 856     // Validate the sockaddr
 857     if (result == 0 && sopt->sopt_valsize != ndrv_multi->addr.sa_len)
 858         result = EINVAL;
 859
 860     if (result == 0 && ndrv_have_multicast(np, &ndrv_multi->addr))
 861         result = EEXIST;
 862
 863     if (result == 0)
 864     {
 865         // Try adding the multicast
 866         result = if_addmulti(np->nd_if, &ndrv_multi->addr, &ndrv_multi->ifma);
 867     }
 868
 869     if (result == 0)
 870     {
 871         // Add to our linked list
 872         ndrv_multi->next = np->nd_multiaddrs;
 873         np->nd_multiaddrs = ndrv_multi;
 874     }
 875     else
 876     {
 877         // Free up the memory, something went wrong
 878         FREE(ndrv_multi, M_IFADDR);
 879     }
 880
 881     return result;
 882 }
 883
 884 static int
 885 ndrv_do_remove_multicast(struct ndrv_cb *np, struct sockopt *sopt)
 886 {
 887     struct sockaddr*            multi_addr;
 888     struct ndrv_multiaddr*      ndrv_entry = NULL;
 889     int                                 result;
 890
 891     if (sopt->sopt_val == NULL || sopt->sopt_valsize < 2 ||
 892         sopt->sopt_level != SOL_NDRVPROTO)
 893         return EINVAL;
 894     if (np->nd_if == NULL)
 895         return ENXIO;
 896
 897     // Allocate storage
 898     MALLOC(multi_addr, struct sockaddr*, sopt->sopt_valsize,
 899             M_TEMP, M_WAITOK);
 900     if (multi_addr == NULL)
 901         return ENOMEM;
 902
 903     // Copy in the address
 904     result = copyin(sopt->sopt_val, multi_addr, sopt->sopt_valsize);
 905
 906     // Validate the sockaddr
 907     if (result == 0 && sopt->sopt_valsize != multi_addr->sa_len)
 908         result = EINVAL;
 909
 910     if (result == 0)
 911     {
 912         /* Find the old entry */
 913         ndrv_entry = ndrv_have_multicast(np, multi_addr);
 914
 915         if (ndrv_entry == NULL)
 916             result = ENOENT;
 917     }
 918
 919     if (result == 0)
 920     {
 921         // Try deleting the multicast
 922         result = if_delmultiaddr(ndrv_entry->ifma, 0);
 923     }
 924
 925     if (result == 0)
 926     {
 927         // Remove from our linked list
 928         struct ndrv_multiaddr*  cur = np->nd_multiaddrs;
 929
 930         ifma_release(ndrv_entry->ifma);
 931
 932         if (cur == ndrv_entry)
 933         {
 934             np->nd_multiaddrs = cur->next;
 935         }
 936         else
 937         {
 938             for (cur = cur->next; cur != NULL; cur = cur->next)
 939             {
 940                 if (cur->next == ndrv_entry)
 941                 {
 942                     cur->next = cur->next->next;
 943                     break;
 944                 }
 945             }
 946         }
 947
 948         // Free the memory
 949         FREE(ndrv_entry, M_IFADDR);
 950     }
 951     FREE(multi_addr, M_TEMP);
 952
 953     return result;
 954 }
 955
 956 static struct ndrv_multiaddr*
 957 ndrv_have_multicast(struct ndrv_cb *np, struct sockaddr* inAddr)
 958 {
 959     struct ndrv_multiaddr*      cur;
 960     for (cur = np->nd_multiaddrs; cur != NULL; cur = cur->next)
 961     {
 962
 963         if ((inAddr->sa_len == cur->addr.sa_len) &&
 964             (bcmp(&cur->addr, inAddr, inAddr->sa_len) == 0))
 965         {
 966             // Found a match
 967             return cur;
 968         }
 969     }
 970
 971     return NULL;
 972 }
 973
 974 static void
 975 ndrv_remove_all_multicast(struct ndrv_cb* np)
 976 {
 977     struct ndrv_multiaddr*      cur;
 978
 979     if (np->nd_if != NULL)
 980     {
 981         while (np->nd_multiaddrs != NULL)
 982         {
 983             cur = np->nd_multiaddrs;
 984             np->nd_multiaddrs = cur->next;
 985
 986             if_delmultiaddr(cur->ifma, 0);
 987             ifma_release(cur->ifma);
 988             FREE(cur, M_IFADDR);
 989         }
 990     }
 991 }
 992
 993 struct pr_usrreqs ndrv_usrreqs = {
 994         ndrv_abort, pru_accept_notsupp, ndrv_attach, ndrv_bind,
 995         ndrv_connect, pru_connect2_notsupp, pru_control_notsupp, ndrv_detach,
 996         ndrv_disconnect, pru_listen_notsupp, ndrv_peeraddr, pru_rcvd_notsupp,
 997         pru_rcvoob_notsupp, ndrv_send, pru_sense_null, ndrv_shutdown,
 998         ndrv_sockaddr, sosend, soreceive, pru_sopoll_notsupp
 999 };
1000
1001 struct protosw ndrvsw =
1002 {       SOCK_RAW, &ndrvdomain, NDRVPROTO_NDRV, PR_ATOMIC|PR_ADDR,
1003         0, ndrv_output, 0, ndrv_ctloutput,
1004         0, 0, 0, 0,
1005         0, 0,
1006         &ndrv_usrreqs,
1007         0, 0, 0
1008 };
1009
1010 struct domain ndrvdomain =
1011 {       AF_NDRV, "NetDriver", ndrv_dominit, NULL, NULL,
1012         NULL,
1013         NULL, NULL, 0, 0, 0, 0
1014 };