clib_socket: add sendmsg / recvmsg with ancillary data support
[vpp.git] / src / vppinfra / socket.c
index 99b353f..87a9333 100644 (file)
   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 
-#include <sys/un.h>
+#include <stdio.h>
+#include <string.h>            /* strchr */
+#define __USE_GNU
 #include <sys/types.h>
 #include <sys/socket.h>
+#include <sys/un.h>
+#include <sys/stat.h>
 #include <netinet/in.h>
 #include <arpa/inet.h>
 #include <netdb.h>
 #include <unistd.h>
-#include <stdio.h>
 #include <fcntl.h>
-#include <string.h>            /* strchr */
 
 #include <vppinfra/mem.h>
 #include <vppinfra/vec.h>
@@ -199,7 +201,8 @@ default_socket_write (clib_socket_t * s)
   /* A "real" error occurred. */
   if (written < 0)
     {
-      err = clib_error_return_unix (0, "write %wd bytes", tx_len);
+      err = clib_error_return_unix (0, "write %wd bytes (fd %d, '%s')",
+                                   tx_len, s->fd, s->config);
       vec_free (s->tx_buffer);
       goto done;
     }
@@ -231,7 +234,7 @@ default_socket_read (clib_socket_t * sock, int n_bytes)
   u8 *buf;
 
   /* RX side of socket is down once end of file is reached. */
-  if (sock->flags & SOCKET_RX_END_OF_FILE)
+  if (sock->flags & CLIB_SOCKET_F_RX_END_OF_FILE)
     return 0;
 
   fd = sock->fd;
@@ -247,12 +250,13 @@ default_socket_read (clib_socket_t * sock, int n_bytes)
       if (!unix_error_is_fatal (errno))
        goto non_fatal;
 
-      return clib_error_return_unix (0, "read %d bytes", n_bytes);
+      return clib_error_return_unix (0, "read %d bytes (fd %d, '%s')",
+                                    n_bytes, sock->fd, sock->config);
     }
 
   /* Other side closed the socket. */
   if (n_read == 0)
-    sock->flags |= SOCKET_RX_END_OF_FILE;
+    sock->flags |= CLIB_SOCKET_F_RX_END_OF_FILE;
 
 non_fatal:
   _vec_len (sock->rx_buffer) += n_read - n_bytes;
@@ -264,7 +268,92 @@ static clib_error_t *
 default_socket_close (clib_socket_t * s)
 {
   if (close (s->fd) < 0)
-    return clib_error_return_unix (0, "close");
+    return clib_error_return_unix (0, "close (fd %d, %s)", s->fd, s->config);
+  return 0;
+}
+
+static clib_error_t *
+default_socket_sendmsg (clib_socket_t * s, void *msg, int msglen,
+                       int fds[], int num_fds)
+{
+  struct msghdr mh = { 0 };
+  struct iovec iov[1];
+  char ctl[CMSG_SPACE (sizeof (int)) * num_fds];
+  int rv;
+
+  iov[0].iov_base = msg;
+  iov[0].iov_len = msglen;
+  mh.msg_iov = iov;
+  mh.msg_iovlen = 1;
+
+  if (num_fds > 0)
+    {
+      struct cmsghdr *cmsg;
+      memset (&ctl, 0, sizeof (ctl));
+      mh.msg_control = ctl;
+      mh.msg_controllen = sizeof (ctl);
+      cmsg = CMSG_FIRSTHDR (&mh);
+      cmsg->cmsg_len = CMSG_LEN (sizeof (int) * num_fds);
+      cmsg->cmsg_level = SOL_SOCKET;
+      cmsg->cmsg_type = SCM_RIGHTS;
+      memcpy (CMSG_DATA (cmsg), fds, sizeof (int) * num_fds);
+    }
+  rv = sendmsg (s->fd, &mh, 0);
+  if (rv < 0)
+    return clib_error_return_unix (0, "sendmsg");
+  return 0;
+}
+
+
+static clib_error_t *
+default_socket_recvmsg (clib_socket_t * s, void *msg, int msglen,
+                       int fds[], int num_fds)
+{
+  char ctl[CMSG_SPACE (sizeof (int) * num_fds) +
+          CMSG_SPACE (sizeof (struct ucred))];
+  struct msghdr mh = { 0 };
+  struct iovec iov[1];
+  ssize_t size;
+  struct ucred *cr = 0;
+  struct cmsghdr *cmsg;
+
+  iov[0].iov_base = msg;
+  iov[0].iov_len = msglen;
+  mh.msg_iov = iov;
+  mh.msg_iovlen = 1;
+  mh.msg_control = ctl;
+  mh.msg_controllen = sizeof (ctl);
+
+  memset (ctl, 0, sizeof (ctl));
+
+  /* receive the incoming message */
+  size = recvmsg (s->fd, &mh, 0);
+  if (size != msglen)
+    {
+      return (size == 0) ? clib_error_return (0, "disconnected") :
+       clib_error_return_unix (0, "recvmsg: malformed message (fd %d, '%s')",
+                               s->fd, s->config);
+    }
+
+  cmsg = CMSG_FIRSTHDR (&mh);
+  while (cmsg)
+    {
+      if (cmsg->cmsg_level == SOL_SOCKET)
+       {
+         if (cmsg->cmsg_type == SCM_CREDENTIALS)
+           {
+             cr = (struct ucred *) CMSG_DATA (cmsg);
+             s->uid = cr->uid;
+             s->gid = cr->gid;
+             s->pid = cr->pid;
+           }
+         else if (cmsg->cmsg_type == SCM_RIGHTS)
+           {
+             clib_memcpy (fds, CMSG_DATA (cmsg), num_fds * sizeof (int));
+           }
+       }
+      cmsg = CMSG_NXTHDR (&mh, cmsg);
+    }
   return 0;
 }
 
@@ -277,6 +366,10 @@ socket_init_funcs (clib_socket_t * s)
     s->read_func = default_socket_read;
   if (!s->close_func)
     s->close_func = default_socket_close;
+  if (!s->sendmsg_func)
+    s->sendmsg_func = default_socket_sendmsg;
+  if (!s->recvmsg_func)
+    s->recvmsg_func = default_socket_recvmsg;
 }
 
 clib_error_t *
@@ -288,21 +381,26 @@ clib_socket_init (clib_socket_t * s)
     struct sockaddr_un su;
   } addr;
   socklen_t addr_len = 0;
+  int socket_type;
   clib_error_t *error = 0;
   word port;
 
   error = socket_config (s->config, &addr.sa, &addr_len,
-                        (s->flags & SOCKET_IS_SERVER
+                        (s->flags & CLIB_SOCKET_F_IS_SERVER
                          ? INADDR_LOOPBACK : INADDR_ANY));
   if (error)
     goto done;
 
   socket_init_funcs (s);
 
-  s->fd = socket (addr.sa.sa_family, SOCK_STREAM, 0);
+  socket_type = s->flags & CLIB_SOCKET_F_SEQPACKET ?
+    SOCK_SEQPACKET : SOCK_STREAM;
+
+  s->fd = socket (addr.sa.sa_family, socket_type, 0);
   if (s->fd < 0)
     {
-      error = clib_error_return_unix (0, "socket");
+      error = clib_error_return_unix (0, "socket (fd %d, '%s')",
+                                     s->fd, s->config);
       goto done;
     }
 
@@ -310,7 +408,7 @@ clib_socket_init (clib_socket_t * s)
   if (addr.sa.sa_family == PF_INET)
     port = ((struct sockaddr_in *) &addr)->sin_port;
 
-  if (s->flags & SOCKET_IS_SERVER)
+  if (s->flags & CLIB_SOCKET_F_IS_SERVER)
     {
       uword need_bind = 1;
 
@@ -321,7 +419,8 @@ clib_socket_init (clib_socket_t * s)
              port = find_free_port (s->fd);
              if (port < 0)
                {
-                 error = clib_error_return (0, "no free port");
+                 error = clib_error_return (0, "no free port (fd %d, '%s')",
+                                            s->fd, s->config);
                  goto done;
                }
              need_bind = 0;
@@ -337,32 +436,68 @@ clib_socket_init (clib_socket_t * s)
          clib_unix_warning ("setsockopt SO_REUSEADDR fails");
       }
 
+      if (addr.sa.sa_family == PF_LOCAL && s->flags & CLIB_SOCKET_F_PASSCRED)
+       {
+         int x = 1;
+         if (setsockopt (s->fd, SOL_SOCKET, SO_PASSCRED, &x, sizeof (x)) < 0)
+           {
+             error = clib_error_return_unix (0, "setsockopt (SO_PASSCRED, "
+                                             "fd %d, '%s')", s->fd,
+                                             s->config);
+             goto done;
+           }
+       }
+
       if (need_bind && bind (s->fd, &addr.sa, addr_len) < 0)
        {
-         error = clib_error_return_unix (0, "bind");
+         error = clib_error_return_unix (0, "bind (fd %d, '%s')",
+                                         s->fd, s->config);
          goto done;
        }
 
       if (listen (s->fd, 5) < 0)
        {
-         error = clib_error_return_unix (0, "listen");
+         error = clib_error_return_unix (0, "listen (fd %d, '%s')",
+                                         s->fd, s->config);
          goto done;
        }
+      if (addr.sa.sa_family == PF_LOCAL
+         && s->flags & CLIB_SOCKET_F_ALLOW_GROUP_WRITE)
+       {
+         struct stat st = { 0 };
+         if (stat (((struct sockaddr_un *) &addr)->sun_path, &st) < 0)
+           {
+             error = clib_error_return_unix (0, "stat (fd %d, '%s')",
+                                             s->fd, s->config);
+             goto done;
+           }
+         st.st_mode |= S_IWGRP;
+         if (chmod (((struct sockaddr_un *) &addr)->sun_path, st.st_mode) <
+             0)
+           {
+             error =
+               clib_error_return_unix (0, "chmod (fd %d, '%s', mode %o)",
+                                       s->fd, s->config, st.st_mode);
+             goto done;
+           }
+       }
     }
   else
     {
-      if ((s->flags & SOCKET_NON_BLOCKING_CONNECT)
+      if ((s->flags & CLIB_SOCKET_F_NON_BLOCKING_CONNECT)
          && fcntl (s->fd, F_SETFL, O_NONBLOCK) < 0)
        {
-         error = clib_error_return_unix (0, "fcntl NONBLOCK");
+         error = clib_error_return_unix (0, "fcntl NONBLOCK (fd %d, '%s')",
+                                         s->fd, s->config);
          goto done;
        }
 
       if (connect (s->fd, &addr.sa, addr_len) < 0
-         && !((s->flags & SOCKET_NON_BLOCKING_CONNECT) &&
+         && !((s->flags & CLIB_SOCKET_F_NON_BLOCKING_CONNECT) &&
               errno == EINPROGRESS))
        {
-         error = clib_error_return_unix (0, "connect");
+         error = clib_error_return_unix (0, "connect (fd %d, '%s')",
+                                         s->fd, s->config);
          goto done;
        }
     }
@@ -386,12 +521,14 @@ clib_socket_accept (clib_socket_t * server, clib_socket_t * client)
   /* Accept the new socket connection. */
   client->fd = accept (server->fd, 0, 0);
   if (client->fd < 0)
-    return clib_error_return_unix (0, "accept");
+    return clib_error_return_unix (0, "accept (fd %d, '%s')",
+                                  server->fd, server->config);
 
   /* Set the new socket to be non-blocking. */
   if (fcntl (client->fd, F_SETFL, O_NONBLOCK) < 0)
     {
-      err = clib_error_return_unix (0, "fcntl O_NONBLOCK");
+      err = clib_error_return_unix (0, "fcntl O_NONBLOCK (fd %d)",
+                                   client->fd);
       goto close_client;
     }
 
@@ -399,11 +536,11 @@ clib_socket_accept (clib_socket_t * server, clib_socket_t * client)
   len = sizeof (client->peer);
   if (getpeername (client->fd, (struct sockaddr *) &client->peer, &len) < 0)
     {
-      err = clib_error_return_unix (0, "getpeername");
+      err = clib_error_return_unix (0, "getpeername (fd %d)", client->fd);
       goto close_client;
     }
 
-  client->flags = SOCKET_IS_CLIENT;
+  client->flags = CLIB_SOCKET_F_IS_CLIENT;
 
   socket_init_funcs (client);
   return 0;