xnu-792.10.96.tar.gz

[apple/xnu.git] / bsd / kern / kern_control.c

diff --git a/bsd/kern/kern_control.c b/bsd/kern/kern_control.c
index 7319540f53e19ec32f96b721774c1ef7a39c7c45..daac86d46cc4b9c88e98f156ada71f7eb12afd2b 100644 (file)
--- a/bsd/kern/kern_control.c
+++ b/bsd/kern/kern_control.c
@@ -1,33 +1,30 @@
 /*
 /*

- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1999-2004 Apple Computer, Inc. All rights reserved.

  *
  * @APPLE_LICENSE_HEADER_START@
  * 
  *
  * @APPLE_LICENSE_HEADER_START@
  * 

- * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
+ * The contents of this file constitute Original Code as defined in and
+ * are subject to the Apple Public Source License Version 1.1 (the
+ * "License").  You may not use this file except in compliance with the
+ * License.  Please obtain a copy of the License at
+ * http://www.apple.com/publicsource and read it before using this file.

  * 
  * 

- * This file contains Original Code and/or Modifications of Original Code
- * as defined in and that are subject to the Apple Public Source License
- * Version 2.0 (the 'License'). You may not use this file except in
- * compliance with the License. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
- * 
- * The Original Code and all software distributed under the License are
- * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * This Original Code and all software distributed under the License are
+ * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER

  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
- * Please see the License for the specific language governing rights and
- * limitations under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
+ * License for the specific language governing rights and limitations
+ * under the License.

  * 
  * @APPLE_LICENSE_HEADER_END@
  */
  * 
  * @APPLE_LICENSE_HEADER_END@
  */

-/* Copyright (C) 1999 Apple Computer, Inc. */

 
 /*
 
 /*

- * NKE management domain - allows control connections to
- *  an NKE and to read/write data.
+ * Kernel Control domain - allows control connections to
+ *  and to read/write data.

  *
  *

+ * Vincent Lubet, 040506

  * Christophe Allie, 010928
  * Justin C. Walker, 990319
  */
  * Christophe Allie, 010928
  * Justin C. Walker, 990319
  */


@@ -42,7 +39,6 @@
 #include <sys/domain.h>
 #include <sys/malloc.h>
 #include <sys/mbuf.h>
 #include <sys/domain.h>
 #include <sys/malloc.h>
 #include <sys/mbuf.h>

-#include <net/kext_net.h>

 #include <sys/sys_domain.h>
 #include <sys/kern_event.h>
 #include <sys/kern_control.h>
 #include <sys/sys_domain.h>
 #include <sys/kern_event.h>
 #include <sys/kern_control.h>


@@ -53,7 +49,6 @@
 
 #include <kern/thread.h>
 
 
 #include <kern/thread.h>
 

-

 /*
  * Definitions and vars for we support
  */
 /*
  * Definitions and vars for we support
  */


@@ -62,389 +57,803 @@
 #define CTL_RECVSIZE   (8 * 1024)      /* default buffer size */
 
 /*
 #define CTL_RECVSIZE   (8 * 1024)      /* default buffer size */
 
 /*

- internal structure maintained for each register controller 
-*/
-struct ctl
-{
-    TAILQ_ENTRY(ctl)   next;           /* controller chain */
-    struct socket      *skt;           /* current controlling socket */
+ * Definitions and vars for we support
+ */

 
 

-    /* controller information provided when registering */
-    u_int32_t  id;                     /* unique nke identifier, provided by DTS */
-    u_int32_t  unit;                   /* unit number for use by the nke */
-    void       *userdata;              /* for private use by nke */
-    
-    /* misc communication information */
-    u_int32_t  flags;                  /* support flags */
-    u_int32_t  recvbufsize;            /* request more than the default buffer size */
-    u_int32_t  sendbufsize;            /* request more than the default buffer size */
-    
-    /* Dispatch functions */
-    int        (*connect)(kern_ctl_ref, void *);                       /* Make contact */
-    void       (*disconnect)(kern_ctl_ref, void *);                    /* Break contact */
-    int        (*write) (kern_ctl_ref, void *, struct mbuf *);         /* Send data to nke */
-    int        (*set)(kern_ctl_ref, void *, int, void *, size_t );     /* set ctl configuration */
-    int        (*get)(kern_ctl_ref, void *, int, void *, size_t *);    /* get ctl configuration */
-};
+static u_int32_t               ctl_last_id = 0;
+static u_int32_t               ctl_max = 256;
+static u_int32_t               ctl_maxunit = 65536;
+static lck_grp_attr_t  *ctl_lck_grp_attr = 0;
+static lck_attr_t              *ctl_lck_attr = 0;
+static lck_grp_t               *ctl_lck_grp = 0;
+static lck_mtx_t               *ctl_mtx;

 
 
 /* all the controllers are chained */
 
 
 /* all the controllers are chained */

-TAILQ_HEAD(, ctl)      ctl_head;
-
-int ctl_attach(struct socket *, int, struct proc *);
-int ctl_connect(struct socket *, struct sockaddr *, struct proc *);
-int ctl_disconnect(struct socket *);
-int ctl_ioctl(struct socket *so, u_long cmd, caddr_t data,
+TAILQ_HEAD(, kctl)     ctl_head;
+
+static int ctl_attach(struct socket *, int, struct proc *);
+static int ctl_detach(struct socket *);
+static int ctl_sofreelastref(struct socket *so);
+static int ctl_connect(struct socket *, struct sockaddr *, struct proc *);
+static int ctl_disconnect(struct socket *);
+static int ctl_ioctl(struct socket *so, u_long cmd, caddr_t data,

                   struct ifnet *ifp, struct proc *p);
                   struct ifnet *ifp, struct proc *p);

-int ctl_send(struct socket *, int, struct mbuf *,
+static int ctl_send(struct socket *, int, struct mbuf *,

             struct sockaddr *, struct mbuf *, struct proc *);
             struct sockaddr *, struct mbuf *, struct proc *);

-int ctl_ctloutput(struct socket *, struct sockopt *);
+static int ctl_ctloutput(struct socket *, struct sockopt *);
+static int ctl_peeraddr(struct socket *so, struct sockaddr **nam);

 
 

-struct ctl *ctl_find(u_int32_t, u_int32_t unit);
-void ctl_post_msg(u_long event_code, u_int32_t id, u_int32_t unit);
+static struct kctl *ctl_find_by_id(u_int32_t);
+static struct kctl *ctl_find_by_name(const char *);
+static struct kctl *ctl_find_by_id_unit(u_int32_t id, u_int32_t unit);

 
 

+static struct ctl_cb *kcb_find(struct kctl *, u_int32_t unit);
+static void ctl_post_msg(u_long event_code, u_int32_t id);

 
 

-struct pr_usrreqs ctl_usrreqs =
+static int ctl_lock(struct socket *, int, int);
+static int ctl_unlock(struct socket *, int, int);
+static lck_mtx_t * ctl_getlock(struct socket *, int);
+
+static struct pr_usrreqs ctl_usrreqs =

 {
        pru_abort_notsupp, pru_accept_notsupp, ctl_attach, pru_bind_notsupp,
 {
        pru_abort_notsupp, pru_accept_notsupp, ctl_attach, pru_bind_notsupp,

-       ctl_connect, pru_connect2_notsupp, ctl_ioctl, pru_detach_notsupp,
-       ctl_disconnect, pru_listen_notsupp, pru_peeraddr_notsupp,
+       ctl_connect, pru_connect2_notsupp, ctl_ioctl, ctl_detach,
+       ctl_disconnect, pru_listen_notsupp, ctl_peeraddr,

        pru_rcvd_notsupp, pru_rcvoob_notsupp, ctl_send,
        pru_sense_null, pru_shutdown_notsupp, pru_sockaddr_notsupp,
        pru_rcvd_notsupp, pru_rcvoob_notsupp, ctl_send,
        pru_sense_null, pru_shutdown_notsupp, pru_sockaddr_notsupp,

-       sosend, soreceive, sopoll
+       sosend, soreceive, pru_sopoll_notsupp
+};
+
+static struct protosw kctlswk_dgram =
+{
+       SOCK_DGRAM, &systemdomain, SYSPROTO_CONTROL, 
+       PR_ATOMIC|PR_CONNREQUIRED|PR_PCBLOCK,
+       NULL, NULL, NULL, ctl_ctloutput,
+       NULL, NULL,
+       NULL, NULL, NULL, NULL, &ctl_usrreqs,
+       ctl_lock, ctl_unlock, ctl_getlock, { 0, 0 } , 0, { 0 }

 };
 
 };
 

-struct protosw ctlsw =
+static struct protosw kctlswk_stream =

 {
 {

-       SOCK_DGRAM, &systemdomain, SYSPROTO_CONTROL, PR_ATOMIC|PR_CONNREQUIRED,
+       SOCK_STREAM, &systemdomain, SYSPROTO_CONTROL, 
+       PR_CONNREQUIRED|PR_PCBLOCK,

        NULL, NULL, NULL, ctl_ctloutput,
        NULL, NULL,
        NULL, NULL, NULL, ctl_ctloutput,
        NULL, NULL,

-       NULL, NULL, NULL, NULL, &ctl_usrreqs
+       NULL, NULL, NULL, NULL, &ctl_usrreqs,
+       ctl_lock, ctl_unlock, ctl_getlock, { 0, 0 } , 0, { 0 }

 };
 
 };
 

+

 /*
 /*

- * Install the protosw's for the NKE manager.
+ * Install the protosw's for the Kernel Control manager.

  */
  */

-int
+__private_extern__ int

 kern_control_init(void)
 {
 kern_control_init(void)
 {

-    int retval;
-
-    retval = net_add_proto(&ctlsw, &systemdomain);
-    if (retval) {
-        log(LOG_WARNING, "Can't install Kernel Controller Manager (%d)\n", retval);
-        return retval;
-    }
+       int error = 0;
+       
+       ctl_lck_grp_attr = lck_grp_attr_alloc_init();
+       if (ctl_lck_grp_attr == 0) {
+                       printf(": lck_grp_attr_alloc_init failed\n");
+                       error = ENOMEM;
+                       goto done;
+       }
+                       
+       ctl_lck_grp = lck_grp_alloc_init("Kernel Control Protocol", ctl_lck_grp_attr);
+       if (ctl_lck_grp == 0) {
+                       printf("kern_control_init: lck_grp_alloc_init failed\n");
+                       error = ENOMEM;
+                       goto done;
+       }
+       
+       ctl_lck_attr = lck_attr_alloc_init();
+       if (ctl_lck_attr == 0) {
+                       printf("kern_control_init: lck_attr_alloc_init failed\n");
+                       error = ENOMEM;
+                       goto done;
+       }
+       
+       ctl_mtx = lck_mtx_alloc_init(ctl_lck_grp, ctl_lck_attr);
+       if (ctl_mtx == 0) {
+                       printf("kern_control_init: lck_mtx_alloc_init failed\n");
+                       error = ENOMEM;
+                       goto done;
+       }
+       TAILQ_INIT(&ctl_head);
+       
+       error = net_add_proto(&kctlswk_dgram, &systemdomain);
+       if (error) {
+               log(LOG_WARNING, "kern_control_init: net_add_proto dgram failed (%d)\n", error);
+       }
+       error = net_add_proto(&kctlswk_stream, &systemdomain);
+       if (error) {
+               log(LOG_WARNING, "kern_control_init: net_add_proto stream failed (%d)\n", error);
+       }
+       
+       done:
+       if (error != 0) {
+               if (ctl_mtx) {
+                               lck_mtx_free(ctl_mtx, ctl_lck_grp);
+                               ctl_mtx = 0;
+               }
+               if (ctl_lck_grp) {
+                               lck_grp_free(ctl_lck_grp);
+                               ctl_lck_grp = 0;
+               }
+               if (ctl_lck_grp_attr) {
+                               lck_grp_attr_free(ctl_lck_grp_attr);
+                               ctl_lck_grp_attr = 0;
+               }
+               if (ctl_lck_attr) {
+                               lck_attr_free(ctl_lck_attr);
+                               ctl_lck_attr = 0;
+               }
+       }
+       return error;
+}

 
 

-    TAILQ_INIT(&ctl_head);
-    
-    return(KERN_SUCCESS);
+static void
+kcb_delete(struct ctl_cb *kcb)
+{
+       if (kcb != 0) {
+               if (kcb->mtx != 0)
+                       lck_mtx_free(kcb->mtx, ctl_lck_grp);
+               FREE(kcb, M_TEMP);
+       }

 }
 
 
 /*
  * Kernel Controller user-request functions
 }
 
 
 /*
  * Kernel Controller user-request functions

+ * attach function must exist and succeed 
+ * detach not necessary 
+ * we need a pcb for the per socket mutex

  */
  */

-int
-ctl_attach (struct socket *so, int proto, struct proc *p)
+static int
+ctl_attach(__unused struct socket *so, __unused int proto, __unused struct proc *p)

 {      
 {      

-    /* 
-     * attach function must exist and succeed 
-     * detach not necessary since we use 
-     * connect/disconnect to handle so_pcb
-     */
+       int error = 0;
+       struct ctl_cb                   *kcb = 0;
+
+       MALLOC(kcb, struct ctl_cb *, sizeof(struct ctl_cb), M_TEMP, M_WAITOK);
+       if (kcb == NULL) {
+               error = ENOMEM;
+               goto quit;
+       }
+       bzero(kcb, sizeof(struct ctl_cb));
+       
+       kcb->mtx = lck_mtx_alloc_init(ctl_lck_grp, ctl_lck_attr);
+       if (kcb->mtx == NULL) {
+               error = ENOMEM;
+               goto quit;
+       }
+       kcb->so = so;
+       so->so_pcb = (caddr_t)kcb;
+    
+quit:
+       if (error != 0) {
+               kcb_delete(kcb);
+               kcb = 0;
+       }
+       return error;
+}
+
+static int
+ctl_sofreelastref(struct socket *so)
+{
+    struct ctl_cb      *kcb = (struct ctl_cb *)so->so_pcb;
+
+    so->so_pcb = 0;

     
     

+    if (kcb != 0) {
+        struct kctl            *kctl;
+        if ((kctl = kcb->kctl) != 0) {
+            lck_mtx_lock(ctl_mtx);
+            TAILQ_REMOVE(&kctl->kcb_head, kcb, next);
+            lck_mtx_lock(ctl_mtx);
+       }
+       kcb_delete(kcb);
+    }

     return 0;
 }
 
     return 0;
 }
 

-int
-ctl_connect(struct socket *so, struct sockaddr *nam, struct proc *p)
-{      
-    struct ctl         *ctl;
-    int                error = 0;
-    struct sockaddr_ctl *sa = (struct sockaddr_ctl *)nam;
+static int
+ctl_detach(struct socket *so)
+{
+    struct ctl_cb      *kcb = (struct ctl_cb *)so->so_pcb;
+    
+    if (kcb == 0)
+       return 0;

 
 

-    ctl = ctl_find(sa->sc_id, sa->sc_unit);
-    if (ctl == NULL)
-        return(EADDRNOTAVAIL);
+    soisdisconnected(so);    
+    so->so_flags |= SOF_PCBCLEARING;
+    return 0;
+}

 
 

-    if (ctl->skt != NULL)
-        return(EBUSY);

 
 

-    error = soreserve(so, 
-        ctl->sendbufsize ? ctl->sendbufsize : CTL_SENDSIZE,
-        ctl->recvbufsize ? ctl->recvbufsize : CTL_RECVSIZE);
-    if (error)
-        return error;
+static int
+ctl_connect(struct socket *so, struct sockaddr *nam, __unused struct proc *p)
+{      
+    struct kctl                        *kctl;
+    int                                        error = 0;
+    struct sockaddr_ctl        sa;
+    struct ctl_cb              *kcb = (struct ctl_cb *)so->so_pcb;

     
     

-    ctl->skt = so;
+    if (kcb == 0)
+       panic("ctl_connect so_pcb null\n");

     
     

-    if (ctl->flags & CTL_FLAG_PRIVILEGED) {
-        if (p == 0)
-            return(EPERM);
-        if (error = suser(p->p_ucred, &p->p_acflag))
+    if (nam->sa_len !=  sizeof(struct sockaddr_ctl))
+       return(EINVAL);
+    
+    bcopy(nam, &sa, sizeof(struct sockaddr_ctl));
+    
+    lck_mtx_lock(ctl_mtx);
+    kctl = ctl_find_by_id_unit(sa.sc_id, sa.sc_unit);
+    if (kctl == NULL) {
+        lck_mtx_unlock(ctl_mtx);
+        return ENOENT;
+    }
+
+       if (((kctl->flags & CTL_FLAG_REG_SOCK_STREAM) && (so->so_type != SOCK_STREAM)) ||
+               (!(kctl->flags & CTL_FLAG_REG_SOCK_STREAM) && (so->so_type != SOCK_DGRAM))) {
+        lck_mtx_unlock(ctl_mtx);
+        return EPROTOTYPE;
+       }
+
+    if (kctl->flags & CTL_FLAG_PRIVILEGED) {
+        if (p == 0) {
+            lck_mtx_unlock(ctl_mtx);
+            return(EINVAL);
+        }
+        if ((error = proc_suser(p))) {
+            lck_mtx_unlock(ctl_mtx);

             return error;
             return error;

+        }

     }
     }

-    
-    if (ctl->connect)
-        error = (*ctl->connect)(ctl, ctl->userdata);
-    if (error) {
-        ctl->skt = NULL;
-        return error;
+
+       if ((kctl->flags & CTL_FLAG_REG_ID_UNIT) || sa.sc_unit != 0) {
+               if (kcb_find(kctl, sa.sc_unit) != NULL) {
+                       lck_mtx_unlock(ctl_mtx);
+                       return EBUSY;
+               }
+       } else {
+       u_int32_t       unit = kctl->lastunit + 1;
+       
+       while (1) {
+           if (unit == ctl_maxunit)
+               unit = 1;
+                   if (kcb_find(kctl, unit) == NULL) {
+                       kctl->lastunit = sa.sc_unit = unit;
+                       break;
+                   }
+               if (unit++ == kctl->lastunit) {
+                   lck_mtx_unlock(ctl_mtx);
+               return EBUSY;
+           }
+           }

     }
     }

+
+       kcb->unit = sa.sc_unit;
+    kcb->kctl = kctl;
+    TAILQ_INSERT_TAIL(&kctl->kcb_head, kcb, next);
+    lck_mtx_unlock(ctl_mtx);
+
+    error = soreserve(so, kctl->sendbufsize, kctl->recvbufsize);
+    if (error)
+               goto done;
+    soisconnecting(so);

     
     

-    so->so_pcb = (caddr_t)ctl;
-    soisconnected(so);
+       socket_unlock(so, 0);
+    error = (*kctl->connect)(kctl, &sa, &kcb->userdata);
+       socket_lock(so, 0);
+    if (error)
+               goto done;

     
     

+    soisconnected(so);
+
+done:
+    if (error) {
+        soisdisconnected(so);
+        lck_mtx_lock(ctl_mtx);
+        kcb->kctl = 0;
+        kcb->unit = 0;
+        TAILQ_REMOVE(&kctl->kcb_head, kcb, next);
+        lck_mtx_unlock(ctl_mtx);
+    }

     return error;
 }
 
     return error;
 }
 

-int
+static int

 ctl_disconnect(struct socket *so)
 {
 ctl_disconnect(struct socket *so)
 {

-    struct ctl         *ctl;
-
-    if ((ctl = (struct ctl *)so->so_pcb))
-    {
-        if (ctl->disconnect)
-            (*ctl->disconnect)(ctl, ctl->userdata);
-        ctl->skt = NULL;
-        so->so_pcb = NULL;
+    struct ctl_cb      *kcb = (struct ctl_cb *)so->so_pcb;
+
+    if ((kcb = (struct ctl_cb *)so->so_pcb)) {
+        struct kctl            *kctl = kcb->kctl;
+        
+        if (kctl && kctl->disconnect) {
+            socket_unlock(so, 0);
+            (*kctl->disconnect)(kctl, kcb->unit, kcb->userdata);
+            socket_lock(so, 0);
+        }
+        lck_mtx_lock(ctl_mtx);
+        kcb->kctl = 0;
+       kcb->unit = 0;
+        TAILQ_REMOVE(&kctl->kcb_head, kcb, next);

         soisdisconnected(so);
         soisdisconnected(so);

+        lck_mtx_unlock(ctl_mtx);

     }
     return 0;
 }
 
     }
     return 0;
 }
 

-int
-ctl_send(struct socket *so, int flags, struct mbuf *m,
-            struct sockaddr *addr, struct mbuf *control,
-            struct proc *p)
+static int
+ctl_peeraddr(struct socket *so, struct sockaddr **nam)

 {
 {

-    struct ctl         *ctl = (struct ctl *)so->so_pcb;
-    int                error = 0;
-
-    if (ctl == NULL)
-        return(ENOTCONN);
-        
-    if (ctl->write)
-        error = (*ctl->write)(ctl, ctl->userdata, m);
-    
-    return error;
+       struct ctl_cb           *kcb = (struct ctl_cb *)so->so_pcb;
+       struct kctl                     *kctl;
+       struct sockaddr_ctl     sc;
+       
+       if (kcb == NULL)        /* sanity check */
+               return(ENOTCONN);
+       
+       if ((kctl = kcb->kctl) == NULL)
+               return(EINVAL);
+               
+       bzero(&sc, sizeof(struct sockaddr_ctl));
+       sc.sc_len = sizeof(struct sockaddr_ctl);
+       sc.sc_family = AF_SYSTEM;
+       sc.ss_sysaddr = AF_SYS_CONTROL;
+       sc.sc_id =  kctl->id;
+       sc.sc_unit = kcb->unit;
+       
+       *nam = dup_sockaddr((struct sockaddr *)&sc, 1);
+       
+       return 0;

 }
 
 }
 

-int
-ctl_enqueuembuf(void *ctlref, struct mbuf *m, u_int32_t flags)
+static int
+ctl_send(struct socket *so, int flags, struct mbuf *m,
+            __unused struct sockaddr *addr, __unused struct mbuf *control,
+            __unused struct proc *p)

 {
 {

-    struct ctl                 *ctl = (struct ctl *)ctlref;
-    struct socket      *so = (struct socket *)ctl->skt;
-
-    if (ctl == NULL)   /* sanity check */
-        return(EINVAL);
-
-    if (so == NULL)
-        return(ENOTCONN);
-
-    if (sbspace(&so->so_rcv) < m->m_pkthdr.len)
-        return(ENOBUFS);
-
-    sbappend(&so->so_rcv, m);
-    if ((flags & CTL_DATA_NOWAKEUP) == 0)
-        sorwakeup(so);
-    return 0;
+       int             error = 0;
+       struct ctl_cb   *kcb = (struct ctl_cb *)so->so_pcb;
+       struct kctl             *kctl;
+       
+       if (kcb == NULL)        /* sanity check */
+               return(ENOTCONN);
+       
+       if ((kctl = kcb->kctl) == NULL)
+               return(EINVAL);
+               
+       if (kctl->send) {
+               socket_unlock(so, 0);
+               error = (*kctl->send)(kctl, kcb->unit, kcb->userdata, m, flags);
+               socket_lock(so, 0);
+       }
+       return error;

 }
 
 }
 

-int
-ctl_enqueuedata(void *ctlref, void *data, size_t len, u_int32_t flags)
+errno_t
+ctl_enqueuembuf(void *kctlref, u_int32_t unit, struct mbuf *m, u_int32_t flags)

 {
 {

-    struct ctl                 *ctl = (struct ctl *)ctlref;
-    struct socket      *so = (struct socket *)ctl->skt;
-    struct mbuf        *m;
-
-    if (ctl == NULL)   /* sanity check */
-        return(EINVAL);
+       struct ctl_cb   *kcb;
+       struct socket   *so;
+       errno_t                 error = 0;
+       struct kctl             *kctl = (struct kctl *)kctlref;
+       
+       if (kctl == NULL)
+               return EINVAL;
+               
+       kcb = kcb_find(kctl, unit);
+       if (kcb == NULL)
+               return EINVAL;
+       
+       so = (struct socket *)kcb->so;
+       if (so == NULL) 
+               return EINVAL;
+       
+       socket_lock(so, 1);
+       if (sbspace(&so->so_rcv) < m->m_pkthdr.len) {
+               error = ENOBUFS;
+               goto bye;
+       }
+       if ((flags & CTL_DATA_EOR))
+               m->m_flags |= M_EOR;
+       if (sbappend(&so->so_rcv, m) && (flags & CTL_DATA_NOWAKEUP) == 0)
+               sorwakeup(so);
+bye:
+       socket_unlock(so, 1);
+       return error;
+}

 
 

-    if (so == NULL)
-        return(ENOTCONN);
+errno_t
+ctl_enqueuedata(void *kctlref, u_int32_t unit, void *data, size_t len, u_int32_t flags)
+{
+       struct ctl_cb   *kcb;
+       struct socket   *so;
+       struct mbuf     *m;
+       errno_t                 error = 0;
+       struct kctl             *kctl = (struct kctl *)kctlref;
+       unsigned int    num_needed;
+       struct mbuf     *n;
+       size_t                  curlen = 0;
+       
+       if (kctlref == NULL)
+               return EINVAL;
+               
+       kcb = kcb_find(kctl, unit);
+       if (kcb == NULL)
+               return EINVAL;
+       
+       so = (struct socket *)kcb->so;
+       if (so == NULL) 
+               return EINVAL;
+       
+       socket_lock(so, 1);
+       if ((size_t)sbspace(&so->so_rcv) < len) {
+               error = ENOBUFS;
+               goto bye;
+       }
+
+       num_needed = 1;
+       m = m_allocpacket_internal(&num_needed, len, NULL, M_NOWAIT, 1, 0);
+       if (m == NULL) {
+               printf("ctl_enqueuedata: m_allocpacket_internal(%lu) failed\n", len);
+               error = ENOBUFS;
+               goto bye;
+       }
+       
+       for (n = m; n != NULL; n = n->m_next) {
+               size_t mlen = mbuf_maxlen(n);
+               
+               if (mlen + curlen > len)
+                       mlen = len - curlen;
+               n->m_len = mlen;
+               bcopy((char *)data + curlen, n->m_data, mlen);
+               curlen += mlen;
+       }
+       mbuf_pkthdr_setlen(m, curlen);
+
+       if ((flags & CTL_DATA_EOR))
+               m->m_flags |= M_EOR;
+       if (sbappend(&so->so_rcv, m) && (flags & CTL_DATA_NOWAKEUP) == 0)
+               sorwakeup(so);
+bye:
+       socket_unlock(so, 1);
+       return error;
+}

 
 

-    if (len > MCLBYTES)
-        return(EMSGSIZE);

 
 

-    if (sbspace(&so->so_rcv) < len)
-        return(ENOBUFS);
-        
-    if ((m = m_gethdr(M_NOWAIT, MT_DATA)) == NULL)
-        return (ENOBUFS);
-    
-    if (len > MHLEN) {
-        MCLGET(m, M_NOWAIT);
-        if (!(m->m_flags & M_EXT)) {
-            m_freem(m);
-            return(ENOBUFS);
-        }
-    }
-
-    bcopy(data, mtod(m, void *), len);
-    
-    sbappend(&so->so_rcv, m);
-    if ((flags & CTL_DATA_NOWAKEUP) == 0)
-        sorwakeup(so);
-    return 0;
+errno_t 
+ctl_getenqueuespace(kern_ctl_ref kctlref, u_int32_t unit, size_t *space)
+{
+       struct ctl_cb   *kcb;
+       struct kctl             *kctl = (struct kctl *)kctlref;
+       struct socket   *so;
+       
+       if (kctlref == NULL || space == NULL)
+               return EINVAL;
+               
+       kcb = kcb_find(kctl, unit);
+       if (kcb == NULL)
+               return EINVAL;
+       
+       so = (struct socket *)kcb->so;
+       if (so == NULL) 
+               return EINVAL;
+       
+       socket_lock(so, 1);
+       *space = sbspace(&so->so_rcv);
+       socket_unlock(so, 1);
+
+       return 0;

 }
 
 }
 

-int
+static int

 ctl_ctloutput(struct socket *so, struct sockopt *sopt)
 {
 ctl_ctloutput(struct socket *so, struct sockopt *sopt)
 {

-    struct ctl *ctl = (struct ctl *)so->so_pcb;
-    int        error = 0, s;
-    void       *data;
-    size_t     len;
+       struct ctl_cb   *kcb = (struct ctl_cb *)so->so_pcb;
+       struct kctl     *kctl;
+       int     error = 0;
+       void    *data;
+       size_t  len;
+       
+       if (sopt->sopt_level != SYSPROTO_CONTROL) {
+               return(EINVAL);
+       }
+       
+       if (kcb == NULL)        /* sanity check */
+               return(ENOTCONN);
+       
+       if ((kctl = kcb->kctl) == NULL)
+               return(EINVAL);
+               
+       switch (sopt->sopt_dir) {
+               case SOPT_SET:
+                       if (kctl->setopt == NULL)
+                               return(ENOTSUP);
+                       MALLOC(data, void *, sopt->sopt_valsize, M_TEMP, M_WAITOK);
+                       if (data == NULL)
+                               return(ENOMEM);
+                       error = sooptcopyin(sopt, data, sopt->sopt_valsize, sopt->sopt_valsize);
+                       if (error == 0) {
+                               socket_unlock(so, 0);
+                               error = (*kctl->setopt)(kcb->kctl, kcb->unit, kcb->userdata, sopt->sopt_name, 
+                                                       data, sopt->sopt_valsize);
+                               socket_lock(so, 0);
+                       }
+                       FREE(data, M_TEMP);
+                       break;
+       
+               case SOPT_GET:
+                       if (kctl->getopt == NULL)
+                               return(ENOTSUP);
+                       data = NULL;
+                       if (sopt->sopt_valsize && sopt->sopt_val) {
+                               MALLOC(data, void *, sopt->sopt_valsize, M_TEMP, M_WAITOK);
+                               if (data == NULL)
+                                       return(ENOMEM);
+                               /* 4108337 - copy in data for get socket option */
+                               error = sooptcopyin(sopt, data, sopt->sopt_valsize, sopt->sopt_valsize);
+                       }
+                       len = sopt->sopt_valsize;
+                       socket_unlock(so, 0);
+                       error = (*kctl->getopt)(kcb->kctl, kcb->unit, kcb->userdata, sopt->sopt_name, 
+                                               data, &len);
+                       socket_lock(so, 0);    
+                       if (error == 0) {
+                               if (data != NULL)
+                                       error = sooptcopyout(sopt, data, len);
+                               else 
+                                       sopt->sopt_valsize = len;
+                       }
+                       if (data != NULL)
+                               FREE(data, M_TEMP);                
+                       break;
+       }
+       return error;
+}

 
 

-    if (sopt->sopt_level != SYSPROTO_CONTROL) {
-        return(EINVAL);
-    }
+static int 
+ctl_ioctl(__unused struct socket *so, u_long cmd, caddr_t data,
+                       __unused struct ifnet *ifp, __unused struct proc *p)
+{
+       int     error = ENOTSUP;
+       
+       switch (cmd) {
+               /* get the number of controllers */
+               case CTLIOCGCOUNT: {
+                       struct kctl     *kctl;
+                       int n = 0;
+
+                       lck_mtx_lock(ctl_mtx);
+                       TAILQ_FOREACH(kctl, &ctl_head, next)
+                               n++;
+                       lck_mtx_unlock(ctl_mtx);
+
+                       *(u_int32_t *)data = n;
+                       error = 0;
+                       break;
+               }
+               case CTLIOCGINFO: {
+                       struct ctl_info *ctl_info = (struct ctl_info *)data;
+                       struct kctl     *kctl = 0;
+                       size_t name_len = strlen(ctl_info->ctl_name);
+                       
+                       if (name_len == 0 || name_len + 1 > MAX_KCTL_NAME) {
+                               error = EINVAL;
+                               break;
+                       }
+                       lck_mtx_lock(ctl_mtx);
+                       kctl = ctl_find_by_name(ctl_info->ctl_name);
+                       lck_mtx_unlock(ctl_mtx);
+                       if (kctl == 0) {
+                               error = ENOENT;
+                               break;
+                       }
+                       ctl_info->ctl_id = kctl->id;
+                       error = 0;
+                       break;
+               }
+       
+               /* add controls to get list of NKEs */
+       
+       }
+       
+       return error;
+}

 
 

-    if (ctl == NULL)
-        return(ENOTCONN);
-        
-    switch (sopt->sopt_dir) {
-        case SOPT_SET:
-            if (ctl->set == NULL)
-                return(ENOTSUP);
-            MALLOC(data, void *, sopt->sopt_valsize, M_TEMP, M_WAITOK);
-            if (data == NULL)
-                return(ENOMEM);
-            error = sooptcopyin(sopt, data, sopt->sopt_valsize, sopt->sopt_valsize);
-            if (error == 0)
-                error = (*ctl->set)(ctl, ctl->userdata, sopt->sopt_name, data, sopt->sopt_valsize);
-            FREE(data, M_TEMP);
-            break;
-
-        case SOPT_GET:
-            if (ctl->get == NULL)
-                return(ENOTSUP);
-            data = NULL;
-            if (sopt->sopt_valsize && sopt->sopt_val) {
-                MALLOC(data, void *, sopt->sopt_valsize, M_TEMP, M_WAITOK);
-                if (data == NULL)
-                    return(ENOMEM);
-            }
-            len = sopt->sopt_valsize;
-            error = (*ctl->get)(ctl, ctl->userdata, sopt->sopt_name, data, &len);
-            if (error == 0) {
-                if (data != NULL)
-                    error = sooptcopyout(sopt, data, len);
-                else 
-                    sopt->sopt_valsize = len;
-            }
-            if (data != NULL)
-                FREE(data, M_TEMP);                
-            break;
-    }
-    return error;
+/*
+ * Register/unregister a NKE
+ */
+errno_t
+ctl_register(struct kern_ctl_reg *userkctl, kern_ctl_ref *kctlref)
+{      
+       struct kctl     *kctl = 0;
+       u_int32_t               id = -1;
+       u_int32_t               n;
+       size_t                  name_len;
+       
+       if (userkctl == NULL)   /* sanity check */
+               return(EINVAL);
+       if (userkctl->ctl_connect == NULL)
+               return(EINVAL);
+       name_len = strlen(userkctl->ctl_name);
+       if (name_len == 0 || name_len + 1 > MAX_KCTL_NAME)
+               return(EINVAL);
+       
+       MALLOC(kctl, struct kctl *, sizeof(*kctl), M_TEMP, M_WAITOK);
+       if (kctl == NULL)
+               return(ENOMEM);
+       bzero((char *)kctl, sizeof(*kctl));
+       
+       lck_mtx_lock(ctl_mtx);
+       
+       if ((userkctl->ctl_flags & CTL_FLAG_REG_ID_UNIT) == 0) {    
+               if (ctl_find_by_name(userkctl->ctl_name) != NULL) {
+                       lck_mtx_unlock(ctl_mtx);
+                       FREE(kctl, M_TEMP);
+                       return(EEXIST);
+               }
+               for (n = 0, id = ctl_last_id + 1; n < ctl_max; id++, n++) {
+                       if (id == 0) {
+                               n--;
+                               continue;
+                       }
+                       if (ctl_find_by_id(id) == 0)
+                               break;
+               }
+               if (id == ctl_max) {
+                       lck_mtx_unlock(ctl_mtx);
+                       FREE(kctl, M_TEMP);
+                       return(ENOBUFS);
+               }
+               userkctl->ctl_id =id;
+               kctl->id = id;
+               kctl->reg_unit = -1;
+       } else {
+               if (ctl_find_by_id_unit(userkctl->ctl_id, userkctl->ctl_unit) != NULL) {
+                       lck_mtx_unlock(ctl_mtx);
+                       FREE(kctl, M_TEMP);
+                       return(EEXIST);
+               }
+               kctl->id = userkctl->ctl_id;
+               kctl->reg_unit = userkctl->ctl_unit;
+       }
+       strcpy(kctl->name, userkctl->ctl_name);
+       kctl->flags = userkctl->ctl_flags;
+
+       /* Let the caller know the default send and receive sizes */
+       if (userkctl->ctl_sendsize == 0)
+               userkctl->ctl_sendsize = CTL_SENDSIZE;
+       kctl->sendbufsize = userkctl->ctl_sendsize;
+
+       if (userkctl->ctl_recvsize == 0)
+               userkctl->ctl_recvsize = CTL_RECVSIZE;
+       kctl->recvbufsize = userkctl->ctl_recvsize;
+
+       kctl->connect = userkctl->ctl_connect;
+       kctl->disconnect = userkctl->ctl_disconnect;
+       kctl->send = userkctl->ctl_send;
+       kctl->setopt = userkctl->ctl_setopt;
+       kctl->getopt = userkctl->ctl_getopt;
+       
+       TAILQ_INIT(&kctl->kcb_head);
+       
+       TAILQ_INSERT_TAIL(&ctl_head, kctl, next);
+       ctl_max++;
+       
+       lck_mtx_unlock(ctl_mtx);
+       
+       *kctlref = kctl;
+       
+       ctl_post_msg(KEV_CTL_REGISTERED, kctl->id);
+       return(0);

 }
 
 }
 

-int ctl_ioctl(struct socket *so, u_long cmd, caddr_t data,
-                  struct ifnet *ifp, struct proc *p)
-{
-    int        error = ENOTSUP, s, n;
-    struct ctl *ctl = (struct ctl *)so->so_pcb;
-    
-    switch (cmd) {
-        /* get the number of controllers */
-        case CTLIOCGCOUNT:
-            n = 0;
-            TAILQ_FOREACH(ctl, &ctl_head, next)
-                n++;
-            *(u_int32_t *)data = n;
-            error = 0;
-            break;
-        
+errno_t
+ctl_deregister(void *kctlref)
+{      
+    struct kctl                *kctl;

 
 

-        /* add controls to get list of NKEs */
+    if (kctlref == NULL)       /* sanity check */
+        return(EINVAL);

 
 

+    lck_mtx_lock(ctl_mtx);
+    TAILQ_FOREACH(kctl, &ctl_head, next) {
+       if (kctl == (struct kctl *)kctlref)
+               break;

     }
     }

+    if (kctl != (struct kctl *)kctlref) {
+        lck_mtx_unlock(ctl_mtx);
+        return EINVAL;
+    }
+       if (!TAILQ_EMPTY(&kctl->kcb_head)) {
+        lck_mtx_unlock(ctl_mtx);
+               return EBUSY;
+       }
+
+    TAILQ_REMOVE(&ctl_head, kctl, next);
+    ctl_max--;
+
+    lck_mtx_unlock(ctl_mtx);

     
     

-    return error;
+    ctl_post_msg(KEV_CTL_DEREGISTERED, kctl->id);
+    FREE(kctl, M_TEMP);
+    return(0);

 }
 
 /*
 }
 
 /*

- * Register/unregister a NKE
+ * Must be called with global lock taked

  */
  */

-int
-ctl_register(struct kern_ctl_reg *userctl, void *userdata, kern_ctl_ref *ctlref)
+static struct kctl *
+ctl_find_by_id(u_int32_t id)

 {      
 {      

-    struct ctl         *ctl;
+    struct kctl        *kctl;

 
 

-    if (userctl == NULL)       /* sanity check */
-        return(EINVAL);
-
-    ctl = ctl_find(userctl->ctl_id, userctl->ctl_unit);
-    if (ctl != NULL)
-        return(EEXIST);
-    
-    MALLOC(ctl, struct ctl *, sizeof(*ctl), M_TEMP, M_WAITOK);
-    if (ctl == NULL)
-        return(ENOMEM);
-        
-    bzero((char *)ctl, sizeof(*ctl));
-
-    ctl->id = userctl->ctl_id;
-    ctl->unit = userctl->ctl_unit;
-    ctl->flags = userctl->ctl_flags;
-    ctl->sendbufsize = userctl->ctl_sendsize;
-    ctl->recvbufsize = userctl->ctl_recvsize;
-    ctl->userdata = userdata;
-    ctl->connect = userctl->ctl_connect;
-    ctl->disconnect = userctl->ctl_disconnect;
-    ctl->write = userctl->ctl_write;
-    ctl->set = userctl->ctl_set;
-    ctl->get = userctl->ctl_get;
-
-    TAILQ_INSERT_TAIL(&ctl_head, ctl, next);
-    
-    *ctlref = ctl;
+    TAILQ_FOREACH(kctl, &ctl_head, next)
+        if (kctl->id == id)
+            return kctl;

 
 

-    ctl_post_msg(KEV_CTL_REGISTERED, ctl->id, ctl->unit);
-    return(0);
+    return NULL;

 }
 
 }
 

-int
-ctl_deregister(void *ctlref)
+/*
+ * Must be called with global ctl_mtx lock taked
+ */
+static struct kctl *
+ctl_find_by_name(const char *name)

 {      
 {      

-    struct ctl         *ctl = (struct ctl *)ctlref;
-    struct socket      *so;
+    struct kctl        *kctl;

 
 

-    if (ctl == NULL)   /* sanity check */
-        return(EINVAL);
+    TAILQ_FOREACH(kctl, &ctl_head, next)
+        if (strcmp(kctl->name, name) == 0)
+            return kctl;

 
 

-    TAILQ_REMOVE(&ctl_head, ctl, next);
+    return NULL;
+}

 
 

-    if (ctl->skt) {
-        ctl->skt->so_pcb = 0;
-        soisdisconnected(ctl->skt);
+/*
+ * Must be called with global ctl_mtx lock taked
+ *
+ */
+static struct kctl *
+ctl_find_by_id_unit(u_int32_t id, u_int32_t unit)
+{      
+    struct kctl        *kctl;
+
+    TAILQ_FOREACH(kctl, &ctl_head, next) {
+        if (kctl->id == id && (kctl->flags & CTL_FLAG_REG_ID_UNIT) == 0)
+            return kctl;
+        else if (kctl->id == id && kctl->reg_unit == unit)
+            return kctl;

     }
     }

-    
-    ctl_post_msg(KEV_CTL_DEREGISTERED, ctl->id, ctl->unit);
-    FREE(ctl, M_TEMP);
-    return(0);
+    return NULL;

 }
 
 /*
 }
 
 /*

- * Locate a NKE
+ * Must be called with kernel controller lock taken

  */
  */

-struct ctl *
-ctl_find(u_int32_t id, u_int32_t unit)
+static struct ctl_cb *
+kcb_find(struct kctl *kctl, u_int32_t unit)

 {      
 {      

-    struct ctl         *ctl;
+    struct ctl_cb      *kcb;

 
 

-    TAILQ_FOREACH(ctl, &ctl_head, next)
-        if ((ctl->id == id) && (ctl->unit == unit))
-            return ctl;
+    TAILQ_FOREACH(kcb, &kctl->kcb_head, next)
+        if ((kcb->unit == unit))
+            return kcb;

 
     return NULL;
 }
 
 
     return NULL;
 }
 

-void ctl_post_msg(u_long event_code, u_int32_t id, u_int32_t unit) 
+/*
+ * Must be called witout lock
+ */
+static void 
+ctl_post_msg(u_long event_code, u_int32_t id) 

 {
     struct ctl_event_data      ctl_ev_data;
     struct kev_msg             ev_msg;
 {
     struct ctl_event_data      ctl_ev_data;
     struct kev_msg             ev_msg;


@@ -458,7 +867,6 @@ void ctl_post_msg(u_long event_code, u_int32_t id, u_int32_t unit)
     /* common nke subclass data */
     bzero(&ctl_ev_data, sizeof(ctl_ev_data));
     ctl_ev_data.ctl_id = id;
     /* common nke subclass data */
     bzero(&ctl_ev_data, sizeof(ctl_ev_data));
     ctl_ev_data.ctl_id = id;

-    ctl_ev_data.ctl_unit = unit;

     ev_msg.dv[0].data_ptr    = &ctl_ev_data;   
     ev_msg.dv[0].data_length = sizeof(ctl_ev_data);
 
     ev_msg.dv[0].data_ptr    = &ctl_ev_data;   
     ev_msg.dv[0].data_length = sizeof(ctl_ev_data);
 


@@ -467,3 +875,80 @@ void ctl_post_msg(u_long event_code, u_int32_t id, u_int32_t unit)
     kev_post_msg(&ev_msg);
 }
 
     kev_post_msg(&ev_msg);
 }
 

+static int
+ctl_lock(struct socket *so, int refcount, int lr)
+ {
+       int lr_saved;
+       if (lr == 0) 
+               lr_saved = (unsigned int) __builtin_return_address(0);
+       else lr_saved = lr;
+       
+       if (so->so_pcb) {
+               lck_mtx_lock(((struct ctl_cb *)so->so_pcb)->mtx);
+       } else  {
+               panic("ctl_lock: so=%x NO PCB! lr=%x\n", so, lr_saved);
+               lck_mtx_lock(so->so_proto->pr_domain->dom_mtx);
+       }
+       
+       if (so->so_usecount < 0)
+               panic("ctl_lock: so=%x so_pcb=%x lr=%x ref=%x\n",
+               so, so->so_pcb, lr_saved, so->so_usecount);
+       
+       if (refcount)
+               so->so_usecount++;
+
+       so->lock_lr[so->next_lock_lr] = (void *)lr_saved;
+       so->next_lock_lr = (so->next_lock_lr+1) % SO_LCKDBG_MAX;
+       return (0);
+}
+
+static int
+ctl_unlock(struct socket *so, int refcount, int lr)
+{
+       int lr_saved;
+       lck_mtx_t * mutex_held;
+       
+       if (lr == 0) 
+               lr_saved = (unsigned int) __builtin_return_address(0);
+       else lr_saved = lr;
+       
+#ifdef MORE_KCTLLOCK_DEBUG
+       printf("ctl_unlock: so=%x sopcb=%x lock=%x ref=%x lr=%x\n",
+                       so, so->so_pcb, ((struct ctl_cb *)so->so_pcb)->mtx, so->so_usecount, lr_saved);
+#endif
+       if (refcount)
+               so->so_usecount--;
+       
+       if (so->so_usecount < 0)
+               panic("ctl_unlock: so=%x usecount=%x\n", so, so->so_usecount);
+       if (so->so_pcb == NULL) {
+               panic("ctl_unlock: so=%x NO PCB usecount=%x lr=%x\n", so, so->so_usecount, lr_saved);
+               mutex_held = so->so_proto->pr_domain->dom_mtx;
+       } else {
+               mutex_held = ((struct ctl_cb *)so->so_pcb)->mtx;
+       }
+       lck_mtx_assert(mutex_held, LCK_MTX_ASSERT_OWNED);
+       so->unlock_lr[so->next_unlock_lr] = (void *)lr_saved;
+       so->next_unlock_lr = (so->next_unlock_lr+1) % SO_LCKDBG_MAX;
+       lck_mtx_unlock(mutex_held);
+       
+       if (so->so_usecount == 0)
+               ctl_sofreelastref(so);
+       
+       return (0);
+}
+
+static lck_mtx_t *
+ctl_getlock(struct socket *so, __unused int locktype)
+{
+       struct ctl_cb *kcb = (struct ctl_cb *)so->so_pcb;
+       
+       if (so->so_pcb)  {
+               if (so->so_usecount < 0)
+                       panic("ctl_getlock: so=%x usecount=%x\n", so, so->so_usecount);
+               return(kcb->mtx);
+       } else {
+               panic("ctl_getlock: so=%x NULL so_pcb\n", so);
+               return (so->so_proto->pr_domain->dom_mtx);
+       }
+}