]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/kern/kpi_socket.c
xnu-1504.7.4.tar.gz
[apple/xnu.git] / bsd / kern / kpi_socket.c
index d589b2ab2bc61b35107c11082c675a0f2bf8436c..fc67ae141c5d3c627a8450a8836dabd58926508c 100644 (file)
@@ -1,26 +1,33 @@
 /*
- * Copyright (c) 2003-2004 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2003-2008 Apple Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
- * 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. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * 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.
  * 
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 
 #define __KPI__
+#include <sys/systm.h>
 #include <sys/kernel.h>
 #include <sys/types.h>
 #include <sys/socket.h>
 #include <sys/filio.h>
 #include <sys/uio_internal.h>
 #include <kern/lock.h>
+#include <netinet/in.h>
+#include <libkern/OSAtomic.h>
 
-extern void    *memcpy(void *, const void *, size_t);
 extern int soclose_locked(struct socket *so);
+extern void soclose_wait_locked(struct socket *so);
+extern int so_isdstlocal(struct socket *so);
 
 errno_t sock_send_internal(
        socket_t                        sock,
@@ -47,6 +57,7 @@ errno_t sock_send_internal(
        int                                     flags,
        size_t                          *sentlen);
 
+typedef        void    (*so_upcall)(struct socket *, caddr_t , int );
 
 
 errno_t
@@ -95,7 +106,7 @@ sock_accept(
                        sock->so_error = ECONNABORTED;
                        break;
                }
-               error = msleep((caddr_t)&sock->so_timeo, mutex_held, PSOCK | PCATCH, "sock_accept", 0);
+               error = msleep((caddr_t)&sock->so_timeo, mutex_held, PSOCK | PCATCH, "sock_accept", NULL);
                if (error) {
                        socket_unlock(sock, 1);
                        return (error);
@@ -111,7 +122,26 @@ sock_accept(
        new_so = TAILQ_FIRST(&sock->so_comp);
        TAILQ_REMOVE(&sock->so_comp, new_so, so_list);
        sock->so_qlen--;
-       socket_unlock(sock, 1); /* release the head */
+
+       /*
+        * Pass the pre-accepted socket to any interested socket filter(s).
+        * Upon failure, the socket would have been closed by the callee.
+        */
+       if (new_so->so_filt != NULL) {
+               /*
+                * Temporarily drop the listening socket's lock before we
+                * hand off control over to the socket filter(s), but keep
+                * a reference so that it won't go away.  We'll grab it
+                * again once we're done with the filter(s).
+                */
+               socket_unlock(sock, 0);
+               if ((error = soacceptfilter(new_so)) != 0) {
+                       /* Drop reference on listening socket */
+                       sodereference(sock);
+                       return (error);
+               }
+               socket_lock(sock, 0);
+       }
 
        if (dosocklock) {
                lck_mtx_assert(new_so->so_proto->pr_getlock(new_so, 0),
@@ -121,12 +151,17 @@ sock_accept(
        
        new_so->so_state &= ~SS_COMP;
        new_so->so_head = NULL;
-       soacceptlock(new_so, &sa, 0);
+       (void) soacceptlock(new_so, &sa, 0);
        
+       socket_unlock(sock, 1); /* release the head */
+
        if (callback) {
-               new_so->so_upcall = callback;
+               new_so->so_upcall = (so_upcall) callback;
                new_so->so_upcallarg = cookie;
                new_so->so_rcv.sb_flags |= SB_UPCALL;
+#if CONFIG_SOWUPCALL
+               new_so->so_snd.sb_flags |= SB_UPCALL;
+#endif
        }
        
        if (sa && from)
@@ -135,6 +170,20 @@ sock_accept(
                memcpy(from, sa, fromlen);
        }
        if (sa) FREE(sa, M_SONAME);
+
+       /*
+        * If the socket has been marked as inactive by soacceptfilter(),
+        * disallow further operations on it.  We explicitly call shutdown
+        * on both data directions to ensure that SS_CANT{RCV,SEND}MORE
+        * states are set for the socket.  This would also flush out data
+        * hanging off the receive list of this socket.
+        */
+       if (new_so->so_flags & SOF_DEFUNCT) {
+               (void) soshutdownlock(new_so, SHUT_RD);
+               (void) soshutdownlock(new_so, SHUT_WR);
+               (void) sodisconnectlocked(new_so);
+       }
+
        *new_sock = new_so;
        if (dosocklock) 
                socket_unlock(new_so, 1);
@@ -148,7 +197,7 @@ sock_bind(
 {
        if (sock == NULL || to == NULL) return EINVAL;
        
-       return sobind(sock, (struct sockaddr*)to);
+       return sobind(sock, (struct sockaddr*)(uintptr_t)to);
 }
 
 errno_t
@@ -170,7 +219,7 @@ sock_connect(
                socket_unlock(sock, 1);
                return EALREADY;
        }
-       error = soconnectlock(sock, (struct sockaddr*)to, 0);
+       error = soconnectlock(sock, (struct sockaddr*)(uintptr_t)to, 0);
        if (!error) {
                if ((sock->so_state & SS_ISCONNECTING) &&
                        ((sock->so_state & SS_NBIO) != 0 || (flags & MSG_DONTWAIT) != 0)) {
@@ -185,7 +234,7 @@ sock_connect(
 
                while ((sock->so_state & SS_ISCONNECTING) && sock->so_error == 0) {
                        error = msleep((caddr_t)&sock->so_timeo, mutex_held, PSOCK | PCATCH,
-                               "sock_connect", 0);
+                               "sock_connect", NULL);
                        if (error)
                                break;
                }
@@ -287,51 +336,92 @@ sock_nointerrupt(
 }
 
 errno_t
-sock_getpeername(
-       socket_t                sock,
-       struct sockaddr *peername,
-       int                             peernamelen)
+sock_getpeername(socket_t sock, struct sockaddr        *peername, int peernamelen)
 {
-       int                             error = 0;
+       int error;
        struct sockaddr *sa = NULL;
-       
-       if (sock == NULL || peername == NULL || peernamelen < 0) return EINVAL;
+
+       if (sock == NULL || peername == NULL || peernamelen < 0)
+               return (EINVAL);
+
        socket_lock(sock, 1);
-       if ((sock->so_state & (SS_ISCONNECTED|SS_ISCONFIRMING)) == 0) {
+       if (!(sock->so_state & (SS_ISCONNECTED|SS_ISCONFIRMING))) {
                socket_unlock(sock, 1);
-               return ENOTCONN;
+               return (ENOTCONN);
        }
-       error = sock->so_proto->pr_usrreqs->pru_peeraddr(sock, &sa);
-       if (!error)
-       {
-               if (peernamelen > sa->sa_len) peernamelen = sa->sa_len;
+       error = sogetaddr_locked(sock, &sa, 1);
+       socket_unlock(sock, 1);
+       if (error == 0) {
+               if (peernamelen > sa->sa_len)
+                       peernamelen = sa->sa_len;
                memcpy(peername, sa, peernamelen);
+               FREE(sa, M_SONAME);
        }
-       if (sa) FREE(sa, M_SONAME);
-       socket_unlock(sock, 1);
-       return error;
+       return (error);
 }
 
 errno_t
-sock_getsockname(
-       socket_t                sock,
-       struct sockaddr *sockname,
-       int                             socknamelen)
+sock_getsockname(socket_t sock, struct sockaddr        *sockname, int socknamelen)
 {
-       int                             error = 0;
+       int error;
        struct sockaddr *sa = NULL;
-       
-       if (sock == NULL || sockname == NULL || socknamelen < 0) return EINVAL;
+
+       if (sock == NULL || sockname == NULL || socknamelen < 0)
+               return (EINVAL);
+
        socket_lock(sock, 1);
-       error = sock->so_proto->pr_usrreqs->pru_sockaddr(sock, &sa);
-       if (!error)
-       {
-               if (socknamelen > sa->sa_len) socknamelen = sa->sa_len;
+       error = sogetaddr_locked(sock, &sa, 0);
+       socket_unlock(sock, 1);
+       if (error == 0) {
+               if (socknamelen > sa->sa_len)
+                       socknamelen = sa->sa_len;
                memcpy(sockname, sa, socknamelen);
+               FREE(sa, M_SONAME);
        }
-       if (sa) FREE(sa, M_SONAME);
+       return (error);
+}
+
+__private_extern__ int
+sogetaddr_locked(struct socket *so, struct sockaddr **psa, int peer)
+{
+       int error;
+
+       if (so == NULL || psa == NULL)
+               return (EINVAL);
+
+       *psa = NULL;
+       error = peer ? so->so_proto->pr_usrreqs->pru_peeraddr(so, psa) :
+           so->so_proto->pr_usrreqs->pru_sockaddr(so, psa);
+
+       if (error == 0 && *psa == NULL) {
+               error = ENOMEM;
+       } else if (error != 0 && *psa != NULL) {
+               FREE(*psa, M_SONAME);
+               *psa = NULL;
+       }
+       return (error);
+}
+
+errno_t
+sock_getaddr(socket_t sock, struct sockaddr **psa, int peer)
+{
+       int error;
+
+       if (sock == NULL || psa == NULL)
+               return (EINVAL);
+
+       socket_lock(sock, 1);
+       error = sogetaddr_locked(sock, psa, peer);
        socket_unlock(sock, 1);
-       return error;
+       
+       return (error);
+}
+
+void
+sock_freeaddr(struct sockaddr *sa)
+{
+       if (sa != NULL)
+               FREE(sa, M_SONAME);
 }
 
 errno_t
@@ -351,7 +441,7 @@ sock_getsockopt(
        sopt.sopt_name = optname;
        sopt.sopt_val = CAST_USER_ADDR_T(optval); 
        sopt.sopt_valsize = *optlen;
-       sopt.sopt_p = NULL;
+       sopt.sopt_p = kernproc;
        error = sogetopt(sock, &sopt); /* will lock socket */
        if (error == 0) *optlen = sopt.sopt_valsize;
        return error;
@@ -363,7 +453,7 @@ sock_ioctl(
        unsigned long request,
        void *argp)
 {
-       return soioctl(sock, request, argp, NULL); /* will lock socket */
+       return soioctl(sock, request, argp, kernproc); /* will lock socket */
 }
 
 errno_t
@@ -382,10 +472,112 @@ sock_setsockopt(
        sopt.sopt_name = optname;
        sopt.sopt_val = CAST_USER_ADDR_T(optval);
        sopt.sopt_valsize = optlen;
-       sopt.sopt_p = NULL;
+       sopt.sopt_p = kernproc;
        return sosetopt(sock, &sopt); /* will lock socket */
 }
 
+errno_t
+sock_settclassopt(
+       socket_t        sock,
+       const void      *optval,
+       size_t          optlen) {
+
+       errno_t error = 0;
+       struct sockopt sopt;
+
+       if (sock == NULL || optval == NULL || optlen == 0) return EINVAL;
+
+       sopt.sopt_dir = SOPT_SET;
+       sopt.sopt_val = CAST_USER_ADDR_T(optval);
+       sopt.sopt_valsize = optlen;
+       sopt.sopt_p = kernproc;
+
+       socket_lock(sock, 1);
+       if (!(sock->so_state & SS_ISCONNECTED)) {
+               /* If the socket is not connected then we don't know 
+                * if the destination is on LAN  or not. Skip
+                * setting traffic class in this case
+                */
+               error = ENOTCONN;
+               goto out;
+       }
+
+       if (sock->so_proto == NULL || sock->so_proto->pr_domain == NULL || sock->so_pcb == NULL) {
+               error = EINVAL;
+               goto out;
+       }
+
+       /* Check if the destination address is LAN or link local address.
+        * We do not want to set traffic class bits if the destination
+        * is not local 
+        */ 
+       if (!so_isdstlocal(sock)) {
+               goto out;
+       }
+
+       switch (sock->so_proto->pr_domain->dom_family) {
+       case AF_INET:
+               sopt.sopt_level = IPPROTO_IP;
+               sopt.sopt_name = IP_TOS;
+               break;
+       case AF_INET6:
+               sopt.sopt_level = IPPROTO_IPV6;
+               sopt.sopt_name = IPV6_TCLASS;
+               break;
+       default:
+               error = EINVAL;
+               goto out;
+       }
+       
+       socket_unlock(sock, 1);
+       return sosetopt(sock, &sopt);
+out:
+       socket_unlock(sock, 1);
+       return error;
+}
+
+errno_t
+sock_gettclassopt(
+       socket_t        sock,
+       void            *optval,
+       size_t          *optlen) {
+
+       errno_t         error = 0;
+       struct sockopt  sopt;
+       
+       if (sock == NULL || optval == NULL || optlen == NULL) return EINVAL;
+
+       sopt.sopt_dir = SOPT_GET;
+       sopt.sopt_val = CAST_USER_ADDR_T(optval); 
+       sopt.sopt_valsize = *optlen;
+       sopt.sopt_p = kernproc;
+
+       socket_lock(sock, 1);
+       if (sock->so_proto == NULL || sock->so_proto->pr_domain == NULL) {
+               socket_unlock(sock, 1);
+               return EINVAL;
+       }
+
+       switch (sock->so_proto->pr_domain->dom_family) {
+       case AF_INET:
+               sopt.sopt_level = IPPROTO_IP;
+               sopt.sopt_name = IP_TOS;
+               break;
+       case AF_INET6:
+               sopt.sopt_level = IPPROTO_IPV6;
+               sopt.sopt_name = IPV6_TCLASS;
+               break;
+       default:
+               socket_unlock(sock, 1);
+               return EINVAL;
+
+       }
+       socket_unlock(sock, 1);
+       error = sogetopt(sock, &sopt); /* will lock socket */
+       if (error == 0) *optlen = sopt.sopt_valsize;
+       return error;
+}
+
 errno_t
 sock_listen(
        socket_t        sock,
@@ -417,7 +609,7 @@ sock_receive_internal(
                                                                  &uio_buf[0], sizeof(uio_buf));
        if (msg && data == NULL) {
                int i;
-               struct iovec_32 *tempp = (struct iovec_32 *) msg->msg_iov;
+               struct iovec *tempp = msg->msg_iov;
                
                for (i = 0; i < msg->msg_iovlen; i++) {
                        uio_addiov(auio, CAST_USER_ADDR_T((tempp + i)->iov_base), (tempp + i)->iov_len);
@@ -431,19 +623,10 @@ sock_receive_internal(
        
        if (recvdlen)
                *recvdlen = 0;
-       
-       if (msg && msg->msg_control) {
-               if ((size_t)msg->msg_controllen < sizeof(struct cmsghdr)) return EINVAL;
-               if ((size_t)msg->msg_controllen > MLEN) return EINVAL;
-               control = m_get(M_NOWAIT, MT_CONTROL);
-               if (control == NULL) return ENOMEM;
-               memcpy(mtod(control, caddr_t), msg->msg_control, msg->msg_controllen);
-               control->m_len = msg->msg_controllen;
-       }
 
        /* let pru_soreceive handle the socket locking */       
        error = sock->so_proto->pr_usrreqs->pru_soreceive(sock, &fromsa, auio,
-                               data, control ? &control : NULL, &flags);
+           data, (msg && msg->msg_control) ? &control : NULL, &flags);
        if (error) goto cleanup;
        
        if (recvdlen)
@@ -487,7 +670,7 @@ sock_receive_internal(
                                clen -= tocopy;
                                m = m->m_next;
                        }
-                       msg->msg_controllen = (u_int32_t)ctlbuf - (u_int32_t)msg->msg_control;
+                       msg->msg_controllen = (uintptr_t)ctlbuf - (uintptr_t)msg->msg_control;
                }
        }
 
@@ -546,7 +729,7 @@ sock_send_internal(
        }
        
        if (data == 0 && msg != NULL) {
-               struct iovec_32 *tempp = (struct iovec_32 *) msg->msg_iov;
+               struct iovec *tempp = msg->msg_iov;
 
                auio = uio_createwithbuffer(msg->msg_iovlen, 0, UIO_SYSSPACE, UIO_WRITE, 
                                                                  &uio_buf[0], sizeof(uio_buf));
@@ -662,7 +845,6 @@ sock_shutdown(
        return soshutdown(sock, how);
 }
 
-typedef        void    (*so_upcall)(struct socket *sock, void* arg, int waitf);
 
 errno_t
 sock_socket(
@@ -680,6 +862,9 @@ sock_socket(
        if (error == 0 && callback)
        {
                (*new_so)->so_rcv.sb_flags |= SB_UPCALL;
+#if CONFIG_SOWUPCALL
+               (*new_so)->so_snd.sb_flags |= SB_UPCALL;
+#endif
                (*new_so)->so_upcall = (so_upcall)callback;
                (*new_so)->so_upcallarg = context;
        }
@@ -708,19 +893,26 @@ sock_retain(
 
 /* Do we want this to be APPLE_PRIVATE API? */
 void
-sock_release(
-       socket_t        sock)
+sock_release(socket_t sock)
 {
-       if (sock == NULL) return;
+       if (sock == NULL)
+               return;
        socket_lock(sock, 1);
+
+       if (sock->so_flags & SOF_UPCALLINUSE)
+               soclose_wait_locked(sock);
+
        sock->so_retaincnt--;
        if (sock->so_retaincnt < 0)
-               panic("sock_release: negative retain count for sock=%x cnt=%x\n",
-                       sock, sock->so_retaincnt);
-       if ((sock->so_retaincnt == 0) && (sock->so_usecount == 2))
-               soclose_locked(sock); /* close socket only if the FD is not holding it */
-       else
-               sock->so_usecount--;    /* remove extra reference holding the socket */
+               panic("sock_release: negative retain count for sock=%p "
+                   "cnt=%x\n", sock, sock->so_retaincnt);
+       if ((sock->so_retaincnt == 0) && (sock->so_usecount == 2)) {
+               /* close socket only if the FD is not holding it */
+               soclose_locked(sock);
+       } else {
+               /* remove extra reference holding the socket */
+               sock->so_usecount--;
+       }
        socket_unlock(sock, 1);
 }
 
@@ -782,3 +974,35 @@ sock_gettype(
        socket_unlock(sock, 1);
        return 0;
 }
+
+/*
+ * Return the listening socket of a pre-accepted socket.  It returns the
+ * listener (so_head) value of a given socket.  This is intended to be
+ * called by a socket filter during a filter attach (sf_attach) callback.
+ * The value returned by this routine is safe to be used only in the
+ * context of that callback, because we hold the listener's lock across
+ * the sflt_initsock() call.
+ */
+socket_t
+sock_getlistener(socket_t sock)
+{
+       return (sock->so_head);
+}
+
+/*
+ * Caller must have ensured socket is valid and won't be going away.
+ */
+void
+socket_set_traffic_mgt_flags(socket_t sock, u_int32_t flags)
+{
+       (void) OSBitOrAtomic(flags, &sock->so_traffic_mgt_flags);
+}
+
+/*
+ * Caller must have ensured socket is valid and won't be going away.
+ */
+void
+socket_clear_traffic_mgt_flags(socket_t sock, u_int32_t flags)
+{
+       (void) OSBitAndAtomic(~flags, &sock->so_traffic_mgt_flags);
+}